Skip to content

chore: update readme #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
emmalu merged 2 commits into from
Apr 9, 2026
Merged

chore: update readme #39

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
128882f
chore: update readme
emmalu Apr 9, 2026
9b89ba4
chore: accept recs from feedback
emmalu Apr 9, 2026
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
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
# csda-version

A Github action to calculate the next [CSDA version](#csda-version) for the checked-out repository.

To use with [release-please](https://github.com/googleapis/release-please):

```yaml
steps:
- uses: actions/checkout@v6
- name: CSDA Version
id: csda-version
uses: gadomski/csda-version
- uses: googleapis/release-please-action@v4
uses: NASA-IMPACT/csda-version@<hash-version> # hash-version is recommended for extra security
- uses: googleapis/release-please-action@<hash-version> # hash-version is recommended for extra security
with:
token: ${{ secrets.GITHUB_TOKEN }}
release-type: simple
release-as: ${{ steps.csda-version.outputs.version }}
```


> [!IMPORTANT]
> You must use `release-type` in your Github Action YAML, you cannot use [Manifest Driven](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md) releasing.
> This is because `release-as` is ignored for manifest-driven releases.

To see this in action, check out https://github.com/gadomski/csdap-demo-repo.
To see this _in_ action, check out https://github.com/NASA-IMPACT/csdap-frontend/blob/main/.github/workflows/release-please.yml.

Copy link
Copy Markdown
Contributor

@camillecroft camillecroft Apr 9, 2026

Choose a reason for hiding this comment

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

Would it be helpful to point to the frontend release-please workflow?
https://github.com/NASA-IMPACT/csdap-frontend/blob/main/.github/workflows/release-please.yml

## CSDA version

Expand All @@ -30,3 +31,6 @@ A CSDA version is formatted like `vYY.PI.SP-X`, where:
- `PI` is the "program increment", which is like a normal calendar quarter except that PI `1` starts Oct 1
- `SP` is the sprint number
- `X` is the release number in this sprint

> [!NOTE]
> While the CSDA `version` _can_ be updated manually (see [example commit](https://github.com/NASA-IMPACT/csda-version/commit/d10da9054f4229fd7c7769066520b14d61ce7c08)), there is [a Github cron job](https://github.com/NASA-IMPACT/csda-version/blob/main/.github/workflows/bump-version.yml) that runs weekly to handle routine [updates](https://github.com/NASA-IMPACT/csda-version/blob/main/src/csda_version/__init__.py).