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

Downstream guide #838

Merged
merged 6 commits into from
Feb 27, 2024
Merged

Downstream guide #838

merged 6 commits into from
Feb 27, 2024

Conversation

lbarcziova
Copy link
Member

@lbarcziova lbarcziova commented Feb 21, 2024

Fixes #802
Fixes #825
Fixes #665

When reviewing, it is probably best to go commit by commit.

TODO:

  • agree on the restructure
  • fix broken links (check also other repos)
  • create docs for CLI pull-from-upstream

RELEASE NOTES BEGIN

N/A

RELEASE NOTES END

Copy link
Contributor

Copy link
Contributor

@lbarcziova lbarcziova marked this pull request as ready for review February 26, 2024 12:55
Copy link
Contributor

Copy link
Member

@majamassarini majamassarini left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really nice the script for updating the docs. Thanks!

.github/workflows/regenerate-cli-help-messages.yml Outdated Show resolved Hide resolved
# `packit pull-from-upstream`

This is a detailed documentation for the update functionality of packit. The
command creates a new pull request in Fedora (or CentOS Stream) using a selected or latest
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
command creates a new pull request in Fedora (or CentOS Stream) using a selected or latest
command creates a new pull request in Fedora (or CentOS Stream) using the selected or the latest

Not sure if this is better but "a selected" does not sounds to me...

## Requirements

* Upstream git repository on GitHub/GitLab.
* Upstream release (read, git tag) where version in spec file is equivalent to
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Upstream release (read, git tag) where version in spec file is equivalent to
* Upstream release (both release and git tag) where version in spec file is equivalent to

Not sure if this is what you mean.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just mostly copied what we already have for propose-downstream, but in fact git tag should be enough from CLI

Copy link
Contributor

Copy link
Member

@TomasTomecek TomasTomecek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like a great improvement, only reviewed it briefly

every time.


:::caution
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I really like this change that most of the retriggering commands are here now.

Copy link
Contributor

Create a dedicated subsection for dist-git repository onboarding.
Include also new information suggested in packit#802

Fixes packit#802
- add manual TOCs with most important section links
- make the structure consistent
- link the downstream one more visibly from upstream one
Copy link
Contributor

@lbarcziova lbarcziova added the mergeit When set, zuul wil gate and merge the PR. label Feb 27, 2024
Copy link
Contributor

Build succeeded (gate pipeline).
https://softwarefactory-project.io/zuul/t/packit-service/buildset/f47b0829886745d399933acd54cb2822

✔️ pre-commit SUCCESS in 1m 16s

Copy link
Contributor

Pull request merge failed: Resource not accessible by integration, You may need to manually rebase your PR and retry.

@lbarcziova lbarcziova merged commit fccd4d7 into packit:main Feb 27, 2024
4 checks passed
@lbarcziova lbarcziova deleted the downstream-guide branch February 27, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mergeit When set, zuul wil gate and merge the PR.
Projects
None yet
3 participants