Skip to content

Commit 082e826

Browse files
author
Max Wang
committed
release notes and tags
1 parent 0100b19 commit 082e826

2 files changed

Lines changed: 50 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1818
- Table metadata operations (create, inspect, delete custom tables)
1919
- Comprehensive error handling with specific exception types (`DataverseError`, `AuthenticationError`, etc.) (#22, #24)
2020
- HTTP retry logic with exponential backoff for resilient operations (#72)
21+
22+
[0.1.0b3]: https://github.com/microsoft/PowerPlatform-DataverseClient-Python/compare/v0.1.0b2...v0.1.0b3
23+
[0.1.0b2]: https://github.com/microsoft/PowerPlatform-DataverseClient-Python/compare/v0.1.0b1...v0.1.0b2
24+
[0.1.0b1]: https://github.com/microsoft/PowerPlatform-DataverseClient-Python/releases/tag/v0.1.0b1

CONTRIBUTING.md

Lines changed: 46 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,49 @@ Before each release, review merged PRs and update the changelog with:
6565
1. Review all PRs merged since last release
6666
2. Add user-facing changes to CHANGELOG.md under appropriate categories
6767
3. Include PR numbers for reference (e.g., `(#123)`)
68-
4. Focus on **why it matters to users**, not implementation details
68+
4. Focus on **why it matters to users**, not implementation details
69+
70+
**Adding version links to CHANGELOG.md:**
71+
72+
After creating tags, add version comparison links at the bottom of CHANGELOG.md:
73+
74+
```markdown
75+
[0.1.0b4]: https://github.com/microsoft/PowerPlatform-DataverseClient-Python/compare/v0.1.0b3...v0.1.0b4
76+
[0.1.0b3]: https://github.com/microsoft/PowerPlatform-DataverseClient-Python/compare/v0.1.0b2...v0.1.0b3
77+
[0.1.0b2]: https://github.com/microsoft/PowerPlatform-DataverseClient-Python/compare/v0.1.0b1...v0.1.0b2
78+
[0.1.0b1]: https://github.com/microsoft/PowerPlatform-DataverseClient-Python/releases/tag/v0.1.0b1
79+
```
80+
81+
### Git Tags and Releases
82+
83+
We use git tags to mark release points and GitHub Releases for announcements.
84+
85+
**Creating Git Tags:**
86+
87+
Git tags should be created for every release published to PyPI:
88+
89+
```bash
90+
# Create annotated tag for version X.Y.Z
91+
git tag -a vX.Y.Z -m "Release vX.Y.Z"
92+
93+
# Push tag to remote
94+
git push origin --tags
95+
```
96+
97+
**GitHub Releases:**
98+
99+
After publishing to PyPI, create a GitHub Release based on CHANGELOG.md
100+
101+
**Release notes format:**
102+
103+
```markdown
104+
Brief summary of the release
105+
106+
### Added
107+
- Feature 1 (#123)
108+
- Feature 2 (#124)
109+
110+
### Fixed
111+
- Bug fix 1 (#125)
112+
- Bug fix 2 (#126)
113+
```

0 commit comments

Comments
 (0)