Add release automation and npm package metadata - #123
Draft
AdrianOrlow wants to merge 1 commit into
Draft
Conversation
Coverage ReportCoverage after merging
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
mainand provide a predictable package layout and versioning for consumers.@gi-org-pl/athena.Description
.github/workflows/release.ymlthat installs deps, builds, prepares a release version, and runsnpm publishusingNODE_AUTH_TOKENon pushes tomain.scripts/set-release-version.mjswhich setspackage.jsonto a unique0.0.0-main.<run>.<attempt>version using GitHub Actions run metadata.package.jsonto publish as@gi-org-pl/athena, expose./dist/athena.js,./dist/main.d.tsand./dist/athena.cssviaexports, add files/publishConfig/repository metadata, and add therelease:versionscript../index.cssinsrc/main.tsand document installation/usage inREADME.md.Testing
npm run buildwhich produceddist/athena.js,dist/athena.css, anddist/main.d.ts(succeeded).npm run lint(callsnpx @biomejs/biome lint) and it completed with no issues (succeeded).GITHUB_RUN_NUMBER=123 GITHUB_RUN_ATTEMPT=2 npm run release:versionto verify version generation and it printed the prepared package version (succeeded).npm pack --dry-runto validate the packaged files list and tarball metadata (succeeded).Codex Task