Skip to content
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# CI

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you put these docs into ReadTheDocs (in docs/) instead?


The CI must be updated whenever there is a new release

### How to create new CI for release

#### Make new scheduled CI for release branch
**1. create new CI file in `.github/workflows` named `ci-<release_version>` in the master branch**

**2. copy the workflow in the `ci-release-TEMPLATE` file over to the `ci-<release_version>` file**

**3. rename the `name` attribute at the top of the file to `CI <release_version>`**

**4. Fill in the checkout action placeholder, use `with: release-<branch-name>` for checkout action**

**5. Uncomment the `schedule` trigger. It's also fine to delete the `pull-request` trigger, that will be handled in the next step**

###backport CI to release branch**

**1. create new CI file in `.github/workflows` named `ci-<release_version>` in the master branch**

**2. copy the workflow in the `ci-release-TEMPLATE` file over to the `ci-<release_version>` file**

**3. rename the `name` attribute at the top of the file to `CI <release_version>`**

**4. Fill in the checkout action placeholder, use `with: fetch-depth: 0` for checkout action**

**5. When creating a release branch, delete all the branch's CI files and add the new ci file.**
Loading