nf-core · edmundmiller · Jul 20, 2024 · Jul 20, 2024 · Jul 20, 2024 · Jul 20, 2024
@@ -4,12 +4,12 @@ on:
     branches:
       - master
     paths:
-      - 'pulumi/test_datasets/**/*'
+      - "pulumi/test_datasets/**/*"
   pull_request:
     branches:
       - master
     paths:
-      - 'pulumi/test_datasets/**/*'
+      - "pulumi/test_datasets/**/*"
 
 # These are the environment variables that jobs in the workflow have access to.
 # By defining them here, all jobs/steps will have access to these variables.
@@ -29,7 +29,6 @@ jobs:
     name: Pulumi
     runs-on: ubuntu-latest
     steps:
-
       # Turnstyle is used to prevent multiple push jobs from running at the same time. We
       # limit it to push jobs to allow PR jobs to run concurrently.
       - name: Turnstyle
@@ -64,7 +63,6 @@ jobs:
           stack-name: ${{ env.PULUMI_STACK_NAME }}
           work-dir: ${{ env.PULUMI_WORKING_DIRECTORY }}
 
-
       # If you'd like to run your Pulumi application outside of the official GitHub Action
 
       #- name: Install Pulumi CLI

@@ -0,0 +1,63 @@
+name: Preview or update Pulumi app nf-core/github-repos/prod
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "pulumi/github/repos/**/*"
+  workflow_dispatch:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - "pulumi/github/repos/**/*"
+
+# These are the environment variables that jobs in the workflow have access to.
+# By defining them here, all jobs/steps will have access to these variables.
+env:
+  # IMPORTANT! You must map the env vars for your cloud provider here even though you add them as secrets
+  # to this repository.
+  # See the setup page for cloud providers here: https://www.pulumi.com/docs/intro/cloud-providers/.
+  # For example, if you are using AWS, then you should add the following:
+  # AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+  # AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
+  PULUMI_ACCESS_TOKEN: ${{ secrets.PULUMI_ACCESS_TOKEN }}
+  PULUMI_STACK_NAME: nf-core/github-repos/prod
+  PULUMI_WORKING_DIRECTORY: pulumi/github/repos/
+
+jobs:
+  pulumi:
+    name: Pulumi
+    runs-on: ubuntu-latest
+    steps:
+      # Turnstyle is used to prevent multiple push jobs from running at the same time. We
+      # limit it to push jobs to allow PR jobs to run concurrently.
+      - name: Turnstyle
+        if: ${{ github.event_name == 'push' }}
+        uses: softprops/turnstyle@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/checkout@v2
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        cache: "pip"
+
+      - run: pip install -r requirements.txt
+        working-directory: ${{ env.PULUMI_WORKING_DIRECTORY }}
+
+      - name: PR previews
+        uses: pulumi/actions@v6
+        with:
+          command: preview
+          stack-name: ${{ env.PULUMI_STACK_NAME }}
+          work-dir: ${{ env.PULUMI_WORKING_DIRECTORY }}
+
+      - name: Apply infrastructure update
+        if: ${{ github.event_name == 'push' }}
+        uses: pulumi/actions@v6
+        with:
+          command: up
+          stack-name: ${{ env.PULUMI_STACK_NAME }}
+          work-dir: ${{ env.PULUMI_WORKING_DIRECTORY }}
@@ -0,0 +1,29 @@
+# Pulumi
+
+[Pulumi Shell Plugin](https://developer.1password.com/docs/cli/shell-plugins/pulumi/)
+
+[How to use 1Password with different accounts automatically](https://developer.1password.com/docs/cli/shell-plugins/multiple-accounts/)
+
+```console
+cd ~/src/nf-core
+
+op signin
+
+# Select nf-core
+
+op plugin init pulumi
+```
+
+This should result in:
+
+```
+
+Pulumi CLI
+Authenticate with Pulumi Personal Access Token.
+
+? Locate your Pulumi Personal Access Token: Search in 1Password...
+
+? Locate your Pulumi Personal Access Token: Pulumi Personal Access Token (Private)
+
+? Configure when the chosen credential(s) will be used to authenticate: Use automatically when in this directory or subdirectories
+```
@@ -0,0 +1,72 @@
+# Pulumi
+
+nf-core specific docs, links and guides.
+
+## Quick Start
+
+### Repo structure
+
+This repo is a "Monorepo", basically a bunch of smaller projects inside of one bigger project.
+
+```console
+tree -L 1 pulumi
+pulumi
+├── AWSMegatests
+├── github
+├── repo-backups
+├── sentieon-license-server
+└── test-datasets
+```
+
+Each of these are their own projects.
+
+### Install Pulumi
+
+[Here's the official guide](https://www.pulumi.com/docs/clouds/aws/get-started/)
+
+### Working with this repo
+
+<!-- TODO Need someone fresh to run through this so we can see where the pain points are-->
+
+1. Open up the project you want to make a change to
+2. Make the change (Probably in `__main.py__`)
+3. If you have a Pulumi cloud account in the nf-core org `pulumi preview` and `pulumi up` should work locally
+4. Create a branch in the repo and make a PR, and a preview of the deployment should get ran.
+
+## Terminology
+
+Pulumi is pretty heavy on the terms and it was kinda confusing. A hierarchy kinda helps
+
+```
+Projects
+├── Stacks
+├──── Deployments
+├──── Resources
+Environments
+```
+
+### Projects
+
+Each directory in `pulumi` is a project.
+
+#### Stacks
+
+Each project can have multiple stacks. For example, `dev`, `prod`, `test`.
+
+Official quote:
+
+> What are projects and stacks? Pulumi projects and stacks let you organize Pulumi code. Consider a Pulumi project to be analogous to a GitHub repo—a single place for code—and a stack to be an instance of that code with a separate configuration. For instance, project foo may have multiple stacks for different deployment environments (dev, test, or prod), or perhaps for different cloud configurations (geographic region for example). See Organizing Projects and Stacks for some best practices on organizing your Pulumi projects and stacks.
+
+https://www.pulumi.com/docs/using-pulumi/organizing-projects-stacks/
+
+##### Deployments
+
+Everytime you push to main in this repo a new deployment of the stack goes out.
+
+##### Resources
+
+These are individual pieces of infrastructure. An EC2 instance, a VPC, a GitHub repo, a GitHub team are some examples.
+
+### Environments
+
+This is Pulumi's hosted Secrete management. I'm thinking of these like, well "Environments". The nf-core AWS, the nf-core Azure, nf-core GCP, nf-core GitHub org, the nf-core-tf GitHub org.
@@ -0,0 +1,3 @@
+*.pyc
+venv/
+__pycache__/
@@ -0,0 +1 @@
+3.12
@@ -0,0 +1,7 @@
+config:
+  github:owner: nf-core-tf
+  # GitHub token stored in 1Password: https://start.1password.com/open/i?a=O5GICFDKPNABLLVGMKBL5JWDWA&v=rdfcz6oy6qxxrc4clu467a7dmm&i=4ajrv44kc5lcbboa37fr5oydla&h=nf-core.1password.eu
+  # 1Password provider configuration
+  pulumi-onepassword:account: nf-core.1password.eu
+environment:
+  - github-nf-core-tf
@@ -0,0 +1,4 @@
+config:
+  github:owner: nf-core
+  pulumi-onepassword:service_account_token:
+    secure: AAABAOVuHjkvr7WBtuxqrIv2W0MkvP9DkIoAqXc2YKGgbjDWCQWGKrXV0wZbmA+064gFec1V6fPVSphDWm9CPx1yq1WkVSnfX4gpNvQKDtJUFq8dqf5Z0XrNljAEr3Tegp3J6L08wj0zvN8R/HfveoOysKzmn6iUuwCEoizq4Yeaz8z20lWpWorE0ICHo6AXBTTH/qGC1HSW9qFfnGtUPvmnNHt2mLhFjnrOGP6My9m3x3tF9no+ptFdWN54lhCyARcBhn6JP2MhEJ09UPXw+uxwFfj8euwgU/pRsqdu22pJLMLA5mOn5gShYcRFT4eaWoRiu9eYaElItfgB8HSKiWrk26+eDz1VvdjdqfcUeLp7X2BGxD50q3s5Y6IRvHKhYZhJzNGq57qhk4M8sYXcl3sDDLZcKuidv4/NfFlLcop5i4KJ8lVBz1jP0v6QQHWjGXT6U1CvX5EwhqemEO862V/5RRYfy/qX85aVv/Xf01lIosGF2v5C5888F0mh8kelKwZGoqm6K+5o1Cy8V/nfCdmRXCEo7DY0iBYa0LfLmv++587rMs0kS84ocBIm/CjdgLoG+zlJRZGXcA0BlJwcWGYPaJ5J/FNDagMNikjwnHmHcTU0nflbzaArC4GJKMboKhl0OFxU3Z8KmhPIv0tUQBEwceDCi3fbEFdgvgnP0kjbFOgT5LMht44M+0B/r7KWZWwYDmZI5t7Bh5FC+qWg+GUiK5MtpOOy9MNi0gC7WrvTH3vhXpGzfx41EOdu3LF6SycigF0IMznl784PimFX1fMxH+9pX29dUP5LxXkS2INs6QQQOcOmlRKZqEsgZOPA34fzyNQliIj1thmS6GrC80UZcAPQ9HZtvKHX2/EZnzjTKcNvQrwsbRlD2de05xRjKCstAwQJVusN0+t8zMzeqgYUe1+Y9+fQ+5nZ3+uQvj9OvLjHFGuzYUwYAbSnAWgWZgUQ4gXNac7MCR4uc5ENJOByE72yL0SuJrGbhPACOE0rZTx35L88+XD7wGbM0iJ8D/2QU5XOgvXaXHQZk4xxsmDg9hY7klQ1atf05eRD+nO9htMgbuvlWeA478vZo2+BbOjn5ziHlDvs9+/NNi3VmP+10WtEkecL71luvmnMyoxI2oouQfcT9xEWW7Xj830BddVO3lr+C5Sdkp27ZENGEhZruZtpzH4x
@@ -0,0 +1,7 @@
+name: github-repos
+runtime:
+  name: python
+  options:
+    toolchain: uv
+    virtualenv: .venv
+description: Managing nf-core GitHub repos
@@ -0,0 +1,18 @@
+# Repos
+
+Replaces the automatic rule enforcement from the [old Pipeline Health PHP code](https://github.com/nf-core/website/blob/old-site/public_html/pipeline_health.php),
+
+[Main GitHub Issue](https://github.com/nf-core/ops/issues/5)
+[Tracking Milestone](https://github.com/nf-core/ops/milestone/1)
+
+## Useful Docs
+
+- https://www.pulumi.com/registry/packages/github/api-docs/repository/
+- [Old Pipeline Health PHP code](https://github.com/nf-core/website/blob/old-site/public_html/pipeline_health.php)
+- [New Pipeline Health page](https://github.com/nf-core/website/blob/main/sites/pipelines/src/pages/pipeline_health.astro)
+
+### Importing Repos
+
+```sh
+pulumi env run nf-core/github-prod -i pulumi import github:index/repository:Repository testpipeline testpipeline
+```
@@ -0,0 +1,2 @@
+#!/usr/bin/env python
+
@@ -0,0 +1,40 @@
+import pulumi
+import pulumi_github as github
+
+
+nf_core_tf = github.Repository(
+    "nf-core-tf",
+    allow_merge_commit=False,
+    allow_rebase_merge=False,
+    allow_squash_merge=False,
+    default_branch="main",
+    description="Repository to host tool-specific module files for the Nextflow DSL2 community!",
+    has_downloads=True,
+    has_issues=True,
+    has_projects=False,
+    homepage_url="https://nf-co.re",
+    merge_commit_message="",
+    merge_commit_title="",
+    name="modules",
+    security_and_analysis=github.RepositorySecurityAndAnalysisArgs(
+        secret_scanning=github.RepositorySecurityAndAnalysisSecretScanningArgs(
+            status="disabled",
+        ),
+        secret_scanning_push_protection=github.RepositorySecurityAndAnalysisSecretScanningPushProtectionArgs(
+            status="disabled",
+        ),
+    ),
+    squash_merge_commit_message="",
+    squash_merge_commit_title="",
+    topics=[
+        "nextflow",
+        "pipelines",
+        "nf-test",
+        "modules",
+        "nf-core",
+        "dsl2",
+        "workflows",
+    ],
+    visibility="public",
+    opts=pulumi.ResourceOptions(protect=True),
+)
@@ -0,0 +1,16 @@
+- .github
+- basic_training
+- configs
+- logos
+- modules
+- ops
+- prettier-plugin-nextflow
+- references
+- setup-nextflow
+- setup-nf-test
+- sublime
+- test-datasets
+- tools
+- vale
+- vscode-extensionpack
+- website
@@ -0,0 +1,7 @@
+#!/usr/bin/env python
+
+
+# ...
+
+
+# ...