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

feat: add docs for build in-obs #897

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

rxbryan
Copy link

@rxbryan rxbryan commented Jun 26, 2024

Add docs for packit build in-obs

Copy link
Contributor

docs/cli/build/in-obs.md Outdated Show resolved Hide resolved
docs/cli/build/in-obs.md Outdated Show resolved Hide resolved
docs/cli/build/in-obs.md Outdated Show resolved Hide resolved
docs/cli/build/in-obs.md Outdated Show resolved Hide resolved
Copy link
Contributor

Copy link
Contributor


* SPEC file for the project placed in the repository.
* Packit config file placed in the repository.

Copy link

Choose a reason for hiding this comment

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

We definitely have to mention here that the user must have osc configured. Otherwise nothing in here will work.

docs/cli/build/index.md Show resolved Hide resolved
Copy link
Contributor

$ packit build in-obs --project <project_name>
```

## Help
Copy link
Member

Choose a reason for hiding this comment

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

I am not sure if you know this, but this is being regenerated automatically from the real help message so you don't need to take care of updating.. Also, what you put into the help message can be edited in one place (~ packit project) and is then visible both in the help message and on docs...

Copy link
Member

Choose a reason for hiding this comment

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

The script is here.

Copy link
Author

Choose a reason for hiding this comment

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

Okay so the help section is updated automatically

Copy link
Author

Choose a reason for hiding this comment

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

can we leave the other sections in?

Copy link
Member

Choose a reason for hiding this comment

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

Yes, yes!

Copy link
Contributor

@rxbryan rxbryan force-pushed the obs-support branch 2 times, most recently from fb3eb7c to e2e1628 Compare July 24, 2024 14:39
Copy link
Contributor

@lachmanfrantisek
Copy link
Member

@rxbryan can you please rebase this pull-request? (Or, should I take care of it?)

@rxbryan rxbryan marked this pull request as ready for review September 4, 2024 18:31
Copy link
Contributor

@rxbryan
Copy link
Author

rxbryan commented Sep 4, 2024

@rxbryan can you please rebase this pull-request? (Or, should I take care of it?)

Done.

I have also marked the PR ready for review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants