Skip to content

Commit 569b1da

Browse files
committed
feat: add changelog and update relevant files
1 parent 2796c36 commit 569b1da

File tree

4 files changed

+87
-1
lines changed

4 files changed

+87
-1
lines changed

CHANGELOG.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Changelog
2+
3+
All notable changes to **Dataverse Client Javascript** are documented here.
4+
5+
This changelog follows the principles of [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and adheres to [Semantic Versioning](https://semver.org/). This document is intended for developers, contributors, and users who need to understand the technical details.
6+
7+
## [Unreleased]
8+
9+
### Added
10+
11+
### Changed
12+
13+
### Fixed
14+
15+
### Removed
16+
17+
---
18+
19+
## [v2.0.0] -- 2025-07-04
20+
21+
[Unreleased]: https://github.com/IQSS/dataverse-frontend/compare/v2.0.0...develop

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@ First of all thank you very much for your interest in contributing to this proje
1616
- Unit and integration tests pass
1717
- Unit and integration tests for new functionality/fix are added
1818
- Documentation is updated (Any new use case added or modified should be documented in the [Use Cases](./docs/useCases.md) section)
19+
- Changelog is updated with your changes in the `[Unreleased]` section of [CHANGELOG.md](./CHANGELOG.md)
20+
21+
## Maintaining the Changelog
22+
23+
We follow the [Keep a Changelog](https://keepachangelog.com/) format for our changelog. When contributing:
24+
25+
1. **Add your changes to the `[Unreleased]` section** at the top of `CHANGELOG.md`
26+
2. **Categorize your changes** under the appropriate headings:
27+
- **Added** for new features
28+
- **Changed** for changes in existing functionality
29+
- **Removed** for now removed features
30+
- **Fixed** for any bug fixes
31+
3. **Write clear, concise descriptions** that help users understand the impact of changes
32+
4. **Include relevant issue numbers** when applicable
1933

2034
## Code of Conduct
2135

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,10 @@ For detailed information about available use cases see [Use Cases Docs](https://
4040

4141
For detailed information about usage see [Usage Docs](https://github.com/IQSS/dataverse-client-javascript/blob/main/docs/usage.md).
4242

43+
## Changelog
44+
45+
See [CHANGELOG.md](https://github.com/IQSS/dataverse-client-javascript/blob/main/CHANGELOG.md) for a detailed history of changes to this project.
46+
4347
## Contributing
4448

4549
Want to add a new use case or improve an existing one? Please check the [Contributing](https://github.com/IQSS/dataverse-client-javascript/blob/main/CONTRIBUTING.md) section.

docs/making-releases.md

Lines changed: 48 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- [Regular or Hotfix?](#regular-or-hotfix)
55
- [Create Github Issue and Release Branch](#create-github-issue-and-release-branch)
66
- [Update the version](#update-the-version)
7+
- [Update the changelog](#update-the-changelog)
78
- [Merge "release branch" into "main"](#merge-release-branch-into-main)
89
- [Publish the Dataverse Client Javascript package](#publish-the-dataverse-client-javascript-package)
910
- [Create a Draft Release on GitHub and Tag the Version](#create-a-draft-release-on-github-and-tag-the-version)
@@ -42,6 +43,52 @@ This command will update the version in the `package.json` and `package-lock.jso
4243

4344
If everything looks good, you can push the changes to the repository.
4445

46+
## Update the changelog
47+
48+
**Note**: Contributors should have already added their changes to the `[Unreleased]` section as part of their pull requests (see [CONTRIBUTING.md](../.github/CONTRIBUTING.md#changelog-guidelines) for details).
49+
50+
Before releasing, ensure the changelog is properly prepared:
51+
52+
1. **Review the [Unreleased] section** in `CHANGELOG.md` and `packages/design-system/CHANGELOG.md`
53+
2. **Move entries from [Unreleased] to the new version section**:
54+
55+
```markdown
56+
## [vX.X.X] -- YYYY-MM-DD
57+
58+
### Added
59+
60+
- Feature descriptions from unreleased section
61+
62+
### Changed
63+
64+
- Changes from unreleased section
65+
66+
### Fixed
67+
68+
- Bug fixes from unreleased section
69+
70+
### Removed
71+
72+
- Removals from unreleased section
73+
```
74+
75+
3. **Clear the [Unreleased] section** but keep the structure:
76+
77+
```markdown
78+
## [Unreleased]
79+
80+
### Added
81+
82+
### Changed
83+
84+
### Fixed
85+
86+
### Removed
87+
```
88+
89+
4. **Update the version links** at the bottom of the changelog files
90+
5. **Commit the changelog updates** as part of the release preparation
91+
4592
## Merge "release branch" into "main"
4693

4794
Create a pull request to merge the `release` branch into the `main` branch.
@@ -96,7 +143,7 @@ Go to https://github.com/IQSS/dataverse-client-javascript/releases/new to start
96143
97144
- Under "Release title" use the same name as the tag such as v3.5.0.
98145
99-
- Add a description of the changes included in this release. You should include a link to the recently published npm version and summarize the key updates, fixes, or features.
146+
- Add a description of the changes included in this release. You should include a link to the recently published npm version and summarize the key updates, fixes, or features. You can copy the content from the corresponding version section in `CHANGELOG.md` for consistency.
100147
101148
- Click "Save draft" because we do not want to publish the release yet.
102149

0 commit comments

Comments
 (0)