Skip to content
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.

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

Add releases_future_release_uri config #54

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

scolby33
Copy link

@scolby33 scolby33 commented May 10, 2016

Scenario 1:

  • Your releases are not kept in branches but instead are in git tags, so releases_release_uri = 'https://github.com/you/project/releases/tag/v%s'
  • Your unreleased changes are not in a tag, but on branch master! So the automatic link to https://github.com/you/project/releases/tag/vmaster is bad.

Scenario 2:

  • Your releases are kept in branches, so releases_release_uri can be the default
  • Your unreleased changes are not on master but are on develop, so the default link to https://github.com/you/project/tree/master is bad.

This pull request solves both of these problems by adding the releases_future_release_uri config, allowing a custom URI to be set for "faux-releases" separately from normal releases.

I have tested this with my own project and have attempted to run your test suite, but I am not 100% sure I did that correctly, so the running of tests on your end would be appreciated.

EDIT: I see you have Travis integration. Let me write some tests for this feature...

scolby33 added 3 commits May 10, 2016 02:57
…'t have the same link as already existing releases.

(Git tags vs. a current development branch, for example)
@scolby33
Copy link
Author

I have added the new option to the default config in tests/_util.py.

I spent a while trying to find a good way to integrate this change in your tests, but couldn't seem to make it work without resorting to major changes of the test suite. Perhaps you have some pointers as to how I could implement the tests?

It is getting super late (early...) for me, so I'll pick this back up tomorrow.

@tony
Copy link

tony commented Jun 23, 2018

@scolby33 @bitprophet See also: #65

See "Next release" in https://libtmux.git-pull.com/en/latest/history.html. It links to vmaster instead of master.

@tony
Copy link

tony commented Jun 23, 2018

@scolby33 I made a rebase of this at #76. I'm not fully sure if you'd get credit on GH if I made the PR or not. But you are free to rebase on your own or use my rebase on this PR.

@bitprophet This would handle #65 for me. Specifically, we have an issue where we break the normal URL convention sometimes and may want something like this:

releases_release_uri = "https://github.com/tmux-python/libtmux/tree/v%s"
releases_future_release_uri = "https://github.com/tmux-python/libtmux/tree/%s"

The reason why is I prefix version releases with v, e.g. v1.0.0, but unreleased trees are master. So we don't want to use the same template.

tony added a commit to tmux-python/libtmux that referenced this pull request Jun 23, 2018
See also:
- bitprophet/releases#54 (original PR by
  @scolby33)
- bitprophet/releases#76 (rebased branch of
  above PR used in this commit)
- Feature request: bitprophet/releases#65
tony added a commit to tmux-python/tmuxp that referenced this pull request May 12, 2019
Remove releases in favor of a more sphinx-issues and basic reST structuring.
https://github.com/bitprophet/releases was inflexible in cases where we used
v<versionnumber> (v1.2.2) and wanted to link back to master.

Issue / PR:
- bitprophet/releases#54
- bitprophet/releases#76

Other issues is how the behavior did more than styling and issue linking,
sometimes patches only intended for minor releases were also added
to minor releases. Regardless of what it intended to do, it wasn't
compatible with how releases were cut. It does more than the projects
I added to needed.

Instead of using reST sections, it used list items to represent versions. 
Which then go on to build html that a section would anyway.  This feels
out of place when separating versions.

Custom roles used in releases were way too much investment for a
changelog. It'd be worth seeing if the same job could be done by
iterating over node test and linking to issues like GitHub does. e.g #484
@bitprophet bitprophet force-pushed the main branch 8 times, most recently from cda450e to 80e1d49 Compare December 19, 2022 02:07
@bitprophet bitprophet force-pushed the main branch 4 times, most recently from 8d2fe0c to b18cd60 Compare December 31, 2022 04:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants