Comments (2)
@marcoacierno: I believe Oliver is referring to being able to use the RELEASE.md
file to add change-log entries to CHANGELOG.md
without triggering a release.
Oliver said above that this use case is apparently (and quite accidentally) achievable by not specifying one of the three expected release types. In that case, the entry in the RELEASE.md
file is indeed appended to the change-log, at the cost of an unhandled error.
I think it's safe to say that AutoPub's original design assumes that the existence of a RELEASE.md
file conveys the intention to issue a new release. Upon first reading this issue, I wasn't sure how I felt about hijacking that process to add a change-log entry without issuing a new release, particularly if we were to sanction that behavior with official documentation. But the more that I think about it, I do understand (and have myself experienced) that there are times in which it does not make sense to issue a release right away, and then one must remember to collate previous commit message bits into the RELEASE.md
file when the time finally comes to issue a release. The flow that Oliver proposed would allow folks to add change-log entries incrementally and synchronously, as features and bug-fixes are added, as opposed to collecting them at release time.
That said, in a situation where a release is not being issued, no version/date header should be appended, which I imagine would require changes to AutoPub's process for updating the change-log.
In short, I am open to the idea of sanctioning this behavior, but I think someone would need to make a few corresponding changes to eliminate the error and ensure it updates the change-log in an appropriate manner.
from autopub.
If you don't create a RELEASE.md CI should pass doing nothing, for example here
Run with no release file: https://github.com/strawberry-graphql/strawberry/runs/2629096433
Run with release: https://github.com/strawberry-graphql/strawberry/runs/2629084517
This is the workflow file: https://github.com/strawberry-graphql/strawberry/blob/main/.github/workflows/release.yml
@oulenz if you can share the CI you are using and your file it would be useful to debug your issue with CI failing when there is no file :)
from autopub.
Related Issues (20)
- Migrate commans Cleo command-line HOT 2
- Write CHANGELOG header by default HOT 1
- Support python 3.6? HOT 2
- Add option to increase verbosity/logging
- Add contributors names to changelog HOT 2
- Include dates with release HOT 3
- Allow to publish prerelease from PR HOT 3
- Support for plugins HOT 4
- Update "contributed by" message to mention contributor
- Issue with release `Release with tag_name 0.xxx.0 not found` HOT 7
- autopub fails to push release to PyPI HOT 2
- Ideas/proposal for AutoPub 1.0 HOT 5
- Error with httpx HOT 1
- Improve documentation? HOT 2
- protected main branch support? HOT 1
- 404 Client Error: Not Found for url HOT 3
- Ensure `CHANGELOG.md` has a trailing newline
- De-couple commit tagging from GitHub release function HOT 1
- Not updating version in pyproject.toml HOT 4
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from autopub.