Skip to content

Update docs and fix tag issue #62

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
Rub21 merged 3 commits into from
Apr 30, 2026
Merged

Update docs and fix tag issue #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5474416
Update readme with release notes
Rub21 Apr 30, 2026
e65952f
Update readme
Rub21 Apr 30, 2026
cf4f4b8
Fix cli to push tag in the repo
Rub21 Apr 30, 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
7 changes: 5 additions & 2 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,10 +58,13 @@ jobs:
npm run build
git add package.json package-lock.json dist/
git commit -m "Packaging ${NEW_VERSION} with rebuilt /dist"
git tag "v${NEW_VERSION}"
git tag -a "v${NEW_VERSION}" -m "v${NEW_VERSION}"
echo "NEW_VERSION=${NEW_VERSION}" >> "$GITHUB_ENV"

- name: Push to GitHub
run: git push origin staging --follow-tags
run: |
git push origin staging
git push origin "v${NEW_VERSION}"

- name: Publish to npm with provenance
run: npm publish --provenance --access public
21 changes: 20 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,26 @@ Miscellaneous notes:

## Versioning and publishing to npm

> Releases can be automated via [Actions → "Release to npm"](https://github.com/OpenHistoricalMap/map-styles/actions/workflows/release.yml) — click **Run workflow**, choose `patch` / `minor` / `major`, and it builds `/dist`, commits, tags, and publishes with provenance via npm Trusted Publishers (no token required). Manual steps below remain as a fallback.
Releases are **manually triggered** via the [Release to npm](https://github.com/OpenHistoricalMap/map-styles/actions/workflows/release.yml) GitHub Action. Authentication uses npm [Trusted Publishers](https://docs.npmjs.com/trusted-publishers) (OIDC) — no tokens required.

### How to release

1. Make sure your changes are merged into `staging` (PRs are validated automatically by [`validate.yml`](.github/workflows/validate.yml) on every push).
2. Go to [Actions → "Release to npm" → Run workflow](https://github.com/OpenHistoricalMap/map-styles/actions/workflows/release.yml).
3. Pick the branch `staging` and the bump type (`patch` / `minor` / `major`), then click **Run workflow**.
4. The workflow rebuilds `/dist`, creates a single commit `Packaging X.Y.Z with rebuilt /dist`, tags it `vX.Y.Z`, pushes to `staging`, and publishes to npm with verified provenance.
5. Update the OHM properties that depend on `map-styles`. For `ohm-website`, [Dependabot](https://docs.github.com/en/code-security/dependabot) runs daily and will automatically open a PR bumping the `yarn.lock` within ~24 hours of the publish — just review and merge it. The manual fallback steps are documented in the [ohm-website](#ohm-website) section below.

### Why manual?

Manual triggering lets us:
- Batch multiple PRs into a single release (no version churn).
- Choose `patch` / `minor` / `major` per release.
- Avoid publishing on irrelevant changes (README edits, refactors, etc.).

### Manual fallback (without the workflow)

If the GitHub Action is unavailable, the release can be done locally:

1. increment the version in `package.json`, e.g., `0.9.7`
1. commit your style changes, including `/dist/*` & `package.json`, push to GitHub, and [create a corresponding release](https://github.com/OpenHistoricalMap/map-styles/releases/new), e.g., `v0.9.7`
Expand Down
Loading