Improve Github Action Workflow
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 48/100
- Issue type
- Refactor
- Clarity
- Clearly specified
- Activity status
- Stale
- Tech stack
- github-actions, node.js
- Domain
- build-system, ci-cd, devops
Research direction
Open .github/workflows/checks.yml and compare the unchecked items with the existing workflow on the develop branch. Verify the test and build job relationship, update the remaining command and naming items, add the requested header comments, and confirm the workflow configuration is valid.
Written by the indexing model from the issue text.
Description
@danielfdsilva spent time in #24 improving the GitHub workflow.
To keep our git history clean and make reviews easier, we should extract the workflow improvements into their own PR, based on the develop branch.
GitHub Actions Workflow Updates (.github/workflows/checks.yml)
- Add descriptive header comments explaining the workflow purpose
- Update trigger conditions:
- Remove
pushtrigger onmainbranch - Update
pull_requesttypes to:opened,synchronize,reopened,ready_for_review - Add concurrency controls to cancel in-progress runs for the same ref
- Remove
- Update Node.js version strategy:
- Remove hardcoded
NODEenvironment variable - Use
node-version-file: '.nvmrc'to read version from.nvmrcfile
- Remove hardcoded
- Update GitHub Actions to latest versions:
actions/checkout@v2→actions/checkout@v4actions/setup-node@v1→actions/setup-node@v4actions/cache@v2→actions/cache@v4- Remove deprecated
styfle/cancel-workflow-action(replaced by concurrency)
- Simplify cache key:
- Remove
cache-nameenvironment variable - Use
${{ runner.os }}-build-${{ hashFiles('**/package.json') }}
- Remove
- Update job commands:
- Use explicit
yarn run lintinstead ofyarn lint - Use explicit
yarn run testinstead ofyarn test - Use explicit
yarn run buildinstead ofyarn build - Fix build job step name: "Test" → "Build"
- Use explicit
- Ensure
buildjob depends ontestjob (not changed, but verify)
References
- Original PR: #24
- Target branch:
develop
Notes
This is purely infrastructure/tooling changes with no functional code changes to the library itself.
- Dominant language
- TypeScript
- Stars
- 34
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from developmentseed/stac-react
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
All issues in developmentseed/stac-react
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
openzim/mwoffliner#2933 ·
Maintainers usually reply within 1 day
-
Use the README category name for website links and submissionsPossibly taken @dajiaohuang claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
birobirobiro/awesome-shadcn-ui#647 ·
Maintainers usually reply within 2 days
-
check:passed streams:add
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
Urigo/accounter-fullstack#4604 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day