Skip to content

Commit

Permalink
Merge pull request #45 from numfocus/guide_base
Browse files Browse the repository at this point in the history
Base setup for a CI/CD guide
  • Loading branch information
nabobalis authored Aug 20, 2024
2 parents 8b0642d + 8190d24 commit f53715e
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ repos:
"--remove-unused-variable",
]
- repo: https://github.com/charliermarsh/ruff-pre-commit
rev: "v0.5.6"
rev: "v0.6.1"
hooks:
- id: ruff
args: ["--fix"]
Expand Down
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ This repository contains information regarding the NumFOCUS infrastructure.

Main sections:

- [Review Process](https://numfocus.github.io/infrastructure/review_process.html): Information regarding the process for projects to ask for infrastructure and what to expect from the review process
- [Review Process](https://numfocus.github.io/infrastructure/review_process.html): Information regarding the process for projects to ask for infrastructure requests and what to expect from the review process
- [CI/CD Guide](https://numfocus.github.io/infrastructure/ci_cd_guide/index.html): Information regarding getting CI/CD paid for with NumFOCUS funds.
- [Projects](https://numfocus.github.io/infrastructure/projects/index.html): Information regarding NumFOCUS projects that use shared infrastructure
- [Vendors](https://numfocus.github.io/infrastructure/vendors/index.html): Information about NumFOCUS infrastructure providers (e.g., hosting companies)

Expand Down
3 changes: 3 additions & 0 deletions docs/ci_cd_guide/getting_started.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
***************
Getting Started
***************
14 changes: 14 additions & 0 deletions docs/ci_cd_guide/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
******************************
Paying for CI/CD with numFOCUS
******************************

This guide is intended to help you set up a CI/CD pipeline for your project and get it paid for by numFOCUS.

**WIP**

.. toctree::
:maxdepth: 1
:caption: Contents
:glob:

*
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ numFOCUS Project Infrastructure
charter
meeting_notes/index
review_process
ci_cd_guide/index
projects/index
vendors/index

0 comments on commit f53715e

Please sign in to comment.