Skip to content

feat(ipa): IPA Package config, docs and release workflow #855

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
merged 28 commits into from
Aug 1, 2025
Merged

feat(ipa): IPA Package config, docs and release workflow #855

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
850499d
Draft ipa package release workflow
Jul 30, 2025
7b8ee1c
Added npmignore tested with npm pack
Jul 31, 2025
91b086f
Updated CONTRIBUTING documentation to reflect IPA package and convent…
Jul 31, 2025
1230f5d
fix lint errors
Jul 31, 2025
c62b858
fix lint error
Jul 31, 2025
8145b39
Draft version check bash script
Jul 31, 2025
af7742e
Test version checking with fake version bump
Jul 31, 2025
f4f3a09
remove unbound variable
Jul 31, 2025
7c424ce
attempt fix
Jul 31, 2025
7419c93
pipe version script output
Jul 31, 2025
27ad395
fix checkout
Jul 31, 2025
edcbd8e
try env variable
Jul 31, 2025
ddf873a
Include collection in npm package
Jul 31, 2025
1bd1b87
attempt lint fix
Jul 31, 2025
a87eec7
attempt branch fetch fix
Jul 31, 2025
5ef60b0
attempt lint fix
Jul 31, 2025
026a990
Trying to fix possible word splitting
Jul 31, 2025
ada8f22
Trying to fix possible word splitting
Jul 31, 2025
1dcd9e6
unbump version after testing, try different fix
Jul 31, 2025
3f757c2
update ipa release workflow to use version check script
Jul 31, 2025
d07e18a
more fix attempts :(
Jul 31, 2025
f81ef89
Refactor version bump logic
Jul 31, 2025
325f159
Add if to check version change status before publishing
Jul 31, 2025
7ce67f1
Fix output parsing
Jul 31, 2025
54f865b
output correction
Jul 31, 2025
f252db0
Removed unnecessary lines
Aug 1, 2025
4d20230
Update Package release checklist
Aug 1, 2025
61caa35
Refine package release process
Aug 1, 2025
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
1 change: 0 additions & 1 deletion .github/workflows/ipa-changelog.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ jobs:
env:
BASE_BRANCH: ${{ github.event.pull_request.base.ref }}
run: |
chmod +x ./.github/scripts/ipa_version_check.sh
version_changed=$(./.github/scripts/ipa_version_check.sh)
echo "Version changed? ${version_changed}"
echo "version_changed=${version_changed}" >> "${GITHUB_OUTPUT}"
Expand Down
7 changes: 0 additions & 7 deletions .github/workflows/ipa-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,9 @@ jobs:
- name: Fetch Versions
id: version_check
run: |
chmod +x ./.github/scripts/ipa_version_check.sh
version_changed=$(./.github/scripts/ipa_version_check.sh)
echo "Version changed? ${version_changed}"
echo "version_changed=${version_changed}" >> "${GITHUB_ENV}"
- name: Check Version Bump
run: |
if [[ "${{ env.version_changed }}" == "false" ]]; then
echo "No version bump to release."
exit 0
fi

publish:
needs: check-version
Expand Down
16 changes: 10 additions & 6 deletions tools/spectral/ipa/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,18 @@ npm run gen-ipa-docs

- [ ] Reference related issues (e.g., Closes #123)

#### For IPA Package version bump
---

A new version of the IPA package will be released when the version is bumped. Before merging, please run
```
npm run gen-ipa-changelog
```
and commit the changes. The changelog must only be updated alongside a version bump.
## IPA Package Release

A new version of the IPA package will be released when the version in the package.json is changed. To release a new version:

- [ ] Determine whether your update is [major/minor/patch] following [semantic versioning](https://semver.org/)
- [ ] Update the version number in package.json
- [ ] Run `npm run gen-ipa-changelog` and commit the changes.
- [ ] Open a PR and ensure the title is conventional and scoped to IPA (ie: `ci(ipa): new version`)
Copy link
Member

@wtrocki wtrocki Aug 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

Nit: Some wording/intentions changed. Reordered as we say people to bump package and then generate changelog where we need changelog to figure out how to bump package

Suggested change
A new version of the IPA package will be released when the version in the package.json is changed. To release a new version:
- [ ] Determine whether your update is [major/minor/patch] following [semantic versioning](https://semver.org/)
- [ ] Update the version number in package.json
- [ ] Run `npm run gen-ipa-changelog` and commit the changes.
- [ ] Open a PR and ensure the title is conventional and scoped to IPA (ie: `ci(ipa): new version`)
Release process requires generation of changelog and manual update of version in package.json.
A new version of the IPA package will be released when the version in the package.json is changed.
Process:
- [ ] Run `npm run gen-ipa-changelog` and commit the changes.
- [ ] Based on changelog determine whether your update is [major/minor/patch] following [semantic versioning](https://semver.org/)
- [ ] Update the version number in package.json
- [ ]
- [ ] Open a PR and ensure the title is conventional and scoped to IPA (ie: `ci(ipa): package release`)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a good point, I made the assumption here that a version bump will have been reviewed internally given commit history. I will add this nit to fix in our documentation changes ticket

Copy link
Member

@wtrocki wtrocki Aug 1, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I made the assumption here that a version bump will have been reviewed internally given commit history.

IMHO Author owns the bump decision. Otherwise you would have all reviewers duplicating the work of author to validate version bumps


The changelog must only be updated alongside a version bump. A PR for a version release should not include other changes.
---
## Getting Started with IPA Rule Development

Expand Down
Loading