Skip to content

Commit fac83c9

Browse files
MiguelLZPFMiguelLZPF
committed
feat: implement ATS workflow with manual control and validation
- Replace all.publish.yml with ats.publish.yml focused on contracts and SDK only - Add manual trigger with dry-run capability for testing - Remove dependency between SDK and contracts jobs for parallel execution - Update changeset config to use develop as base branch - Support automatic triggers on version tags and release branches - Implement changeset validation workflow to enforce one changeset per PR - Add bypass labels for docs/chore changes (no-changeset, docs-only, hotfix, chore) - Enhance changeset description with comprehensive workflow documentation - Fix .gitignore to allow .github/ tracking for workflows - Resolve changeset validation workflow branch detection issues - Simplify validation logic to avoid monorepo dependency conflicts This establishes a complete develop-first workflow with manual release control, automated changeset validation, parallel publishing capabilities, and enterprise-grade documentation for production-ready release management. Signed-off-by: Miguel_LZPF <miguel.carpena@io.builders>
1 parent b637623 commit fac83c9

File tree

9 files changed

+330
-131
lines changed

9 files changed

+330
-131
lines changed

‎.changeset/changesets-workflow-integration.md‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
'@hashgraph/asset-tokenization-contracts': minor
3+
'@hashgraph/asset-tokenization-sdk': minor
4+
'@hashgraph/asset-tokenization-dapp': minor
5+
---
6+
7+
Integrate Changesets for version management and implement enterprise-grade release workflow
8+
9+
## Changesets Integration
10+
11+
- Add Changesets configuration with fixed versioning for ATS packages (contracts, SDK, dapp)
12+
- Configure develop-branch strategy as base for version management
13+
- Add comprehensive changeset management scripts: create, version, publish, status, snapshot
14+
- Implement automated semantic versioning and changelog generation
15+
- Add @changesets/cli dependency for modern monorepo version management
16+
17+
## Enterprise Release Workflow
18+
19+
- Implement new ats.publish.yml workflow focused exclusively on contracts and SDK packages
20+
- Add manual trigger with dry-run capability for safe testing before actual releases
21+
- Configure parallel execution of contracts and SDK publishing jobs for improved performance
22+
- Support automatic triggers on version tags, release branches, and GitHub releases
23+
- Add changeset validation workflow to enforce one changeset per PR requirement
24+
- Include bypass labels for non-feature changes (no-changeset, docs-only, hotfix, chore)
25+
26+
## Repository Configuration
27+
28+
- Update .gitignore to properly track .github/ workflows while excluding build artifacts
29+
- Remove deprecated all.publish.yml workflow in favor of focused ATS publishing
30+
- Update package.json with complete changeset workflow scripts and release commands
31+
- Enhance documentation with new version management workflow and enterprise practices
32+
33+
## Benefits
34+
35+
- **Modern Version Management**: Semantic versioning with automated changelog generation
36+
- **Enterprise Compliance**: Manual release control with proper audit trails
37+
- **Parallel Publishing**: Improved CI/CD performance with independent job execution
38+
- **Developer Experience**: Simplified workflow with comprehensive documentation
39+
- **Quality Assurance**: Mandatory changeset validation ensures all changes are documented
40+
41+
This establishes a production-ready, enterprise-grade release management system that follows modern monorepo practices while maintaining backward compatibility with existing development workflows.

‎.changeset/config.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
],
1212
"linked": [],
1313
"access": "restricted",
14-
"baseBranch": "main",
14+
"baseBranch": "develop",
1515
"updateInternalDependencies": "patch",
1616
"ignore": []
1717
}

‎.github/workflows/all.publish.yml‎

Lines changed: 0 additions & 93 deletions
This file was deleted.

‎.github/workflows/ats.publish.yml‎

Lines changed: 169 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,169 @@
1+
name: ATS Publish
2+
3+
on:
4+
# Manual trigger with dry-run option
5+
workflow_dispatch:
6+
inputs:
7+
dry-run-enabled:
8+
description: 'Run npm publish with dry-run flag'
9+
required: false
10+
type: boolean
11+
default: false
12+
ref:
13+
description: 'Branch/tag/commit to publish from'
14+
required: false
15+
type: string
16+
default: 'main'
17+
18+
# Release published trigger (GitHub release creation) - only for ATS releases
19+
release:
20+
types:
21+
- published
22+
23+
defaults:
24+
run:
25+
shell: bash
26+
27+
permissions:
28+
contents: read
29+
id-token: write
30+
31+
jobs:
32+
contracts:
33+
name: Publish ATS Contracts
34+
runs-on: token-studio-linux-large
35+
# Only run if manual trigger OR release tag contains 'ats'/'ATS'
36+
if: github.event_name == 'workflow_dispatch' || contains(github.ref_name, 'ats') || contains(github.ref_name, 'ATS')
37+
permissions:
38+
contents: read
39+
id-token: write
40+
41+
steps:
42+
- name: Harden Runner
43+
uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
44+
with:
45+
egress-policy: audit
46+
47+
- name: Checkout repository
48+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
49+
with:
50+
ref: ${{ inputs.ref || github.ref }}
51+
fetch-depth: 0
52+
53+
- name: Setup NodeJS Environment
54+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
55+
with:
56+
node-version: 22.x
57+
registry-url: https://registry.npmjs.org
58+
59+
- name: Create .npmrc file
60+
env:
61+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
62+
run: |
63+
cat << 'EOF' > .npmrc
64+
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
65+
EOF
66+
67+
- name: Install dependencies
68+
run: npm ci
69+
70+
- name: Build ATS Contracts
71+
run: npm run ats:contracts:build
72+
73+
- name: Publish ATS Contracts
74+
env:
75+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
76+
DRY_RUN: ${{ inputs.dry-run-enabled }}
77+
run: |
78+
echo "DRY_RUN is set to: '${DRY_RUN}'"
79+
80+
cd packages/ats/contracts
81+
82+
PUBLISH_ARGS=("--access=restricted")
83+
if [[ "${DRY_RUN}" == "true" ]]; then
84+
PUBLISH_ARGS+=("--dry-run")
85+
echo "🔍 DRY RUN MODE: Would publish @hashgraph/asset-tokenization-contracts"
86+
fi
87+
88+
npm publish "${PUBLISH_ARGS[@]}"
89+
90+
sdk:
91+
name: Publish ATS SDK
92+
runs-on: token-studio-linux-large
93+
# Only run if manual trigger OR release tag contains 'ats'/'ATS'
94+
if: github.event_name == 'workflow_dispatch' || contains(github.ref_name, 'ats') || contains(github.ref_name, 'ATS')
95+
# needs: contracts # Commented out for parallel execution
96+
permissions:
97+
contents: read
98+
id-token: write
99+
100+
steps:
101+
- name: Harden Runner
102+
uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
103+
with:
104+
egress-policy: audit
105+
106+
- name: Checkout repository
107+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
108+
with:
109+
ref: ${{ inputs.ref || github.ref }}
110+
fetch-depth: 0
111+
112+
- name: Setup NodeJS Environment
113+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
114+
with:
115+
node-version: 22.x
116+
registry-url: https://registry.npmjs.org
117+
118+
- name: Create .npmrc file
119+
env:
120+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
121+
run: |
122+
cat << 'EOF' > .npmrc
123+
//registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN}
124+
EOF
125+
126+
- name: Install dependencies
127+
run: npm ci
128+
129+
- name: Build ATS Contracts and SDK
130+
run: |
131+
npm run ats:contracts:build
132+
npm run ats:sdk:build
133+
134+
- name: Publish ATS SDK
135+
env:
136+
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
137+
DRY_RUN: ${{ inputs.dry-run-enabled }}
138+
run: |
139+
echo "DRY_RUN is set to: '${DRY_RUN}'"
140+
141+
cd packages/ats/sdk
142+
143+
PUBLISH_ARGS=("--access=restricted")
144+
if [[ "${DRY_RUN}" == "true" ]]; then
145+
PUBLISH_ARGS+=("--dry-run")
146+
echo "🔍 DRY RUN MODE: Would publish @hashgraph/asset-tokenization-sdk"
147+
fi
148+
149+
npm publish "${PUBLISH_ARGS[@]}"
150+
151+
# Summary job to report results
152+
summary:
153+
name: Publish Summary
154+
runs-on: token-studio-linux-large
155+
needs: [contracts, sdk]
156+
if: always()
157+
steps:
158+
- name: Report Results
159+
run: |
160+
echo "## ATS Publish Results" >> $GITHUB_STEP_SUMMARY
161+
echo "| Package | Status |" >> $GITHUB_STEP_SUMMARY
162+
echo "| --- | --- |" >> $GITHUB_STEP_SUMMARY
163+
echo "| Contracts | ${{ needs.contracts.result }} |" >> $GITHUB_STEP_SUMMARY
164+
echo "| SDK | ${{ needs.sdk.result }} |" >> $GITHUB_STEP_SUMMARY
165+
166+
if [[ "${{ inputs.dry-run-enabled }}" == "true" ]]; then
167+
echo "" >> $GITHUB_STEP_SUMMARY
168+
echo "🔍 **DRY RUN MODE** - No packages were actually published" >> $GITHUB_STEP_SUMMARY
169+
fi

0 commit comments

Comments
 (0)