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

ug: custom-ci: Switch to usage of the new compose publish utility #764

Merged
merged 1 commit into from
Oct 29, 2024

Conversation

mike-sul
Copy link
Contributor

@mike-sul mike-sul commented Oct 28, 2024

Replace references to compose-publish utility with references to composectl publish utility since we moved all App related functionality into the single component composectl and will be doing further development only in the scope of composeapp project.

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Why merge this PR? What does it solve?

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

Replace references to `compose-publish` utility with references to
`composectl publish` utility since we moved all App related
functionality into the single component `composectl` and will be
doing further development only in the scope of `composeapp` project.

Signed-off-by: Mike Sul <[email protected]>
@doanac
Copy link
Member

doanac commented Oct 28, 2024

@mike-sul mike-sul marked this pull request as ready for review October 28, 2024 12:18
@mike-sul
Copy link
Contributor Author

@vanmaegima @caiotpereira Updating the doc on the custom Ci for Apps so it references the composectl publish instead of compose-publish. The gihub workflow example was updated too.

@mike-sul
Copy link
Contributor Author

@kprosise FYI, this update is not bound to LmP version/release hence can be merged into main and published at any time.

@mike-sul
Copy link
Contributor Author

@kprosise It looks like the test/vale failure is not related to this PR change.

Copy link
Contributor

@kprosise kprosise left a comment

Choose a reason for hiding this comment

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

LGTM!

@kprosise kprosise merged commit aaeeb04 into main Oct 29, 2024
2 of 3 checks passed
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.

4 participants