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.

Sign up for GitHub

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

Jump to bottom

Issue 1669: Update GitHub Maven docs Super POM and context #1670

Merged
merged 21 commits into from
Mar 4, 2021
Merged

Issue 1669: Update GitHub Maven docs Super POM and context #1670

merged 21 commits into from
Mar 4, 2021

Conversation

timothystone
Copy link
Contributor

@timothystone timothystone commented Nov 28, 2020 •
edited
Loading

Why:

The GitHub Maven configuration overrides default behaviors of the Maven Super POM on central releases. It additionally makes notes on configuring user settings out of context of consuming projects of packages.

See #1669

What's being changed:

Documentation on Maven Configuration for GitHub Packages.

Check off the following:

  • All of the tests are passing.
  • I have reviewed my changes in staging. (look for the deploy-to-heroku link in your pull request, then click View deployment)
  • For content changes, I have reviewed the localization checklist
  • For content changes, I have reviewed the Content style guide for GitHub Docs.

@timothystone
Update GitHub Maven docs Super POM and context
9455624 
The GitHub Maven configuration overrides default behaviors of the Maven
Super POM on central releases. It additionally makes notes on
configuring user settings out of context of consuming projects of
packages.
@welcome
Copy link

welcome bot commented Nov 28, 2020

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@timothystone
Encode XML comments for display
06d41ff 
Comments are stripped from code fences in github markdown for XML
@timothystone
Remove XML code fence language hint
c01d36b 
Attempting to retain comments in documentation.
@timothystone
Use pre element to retain comments
f735288 
GitHub Markdown strips comments from code fences. Attempting to retain
comments with explicit HTML element.
@timothystone
Provide example of multiple repositories
d463997 
GitHub Maven Packages may require multiple repositories where many
different packages are used or consumed. This is a limitation of the
group/organization package resolution.
@janiceilene
Copy link
Contributor

Thanks so much for opening a PR! I'll get this triaged for review ⚡

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team packages This issue or pull request should be reviewed by the docs packages team labels Nov 30, 2020
@janiceilene janiceilene linked an issue Dec 4, 2020 that may be closed by this pull request
Update the Apache Maven Package configuration documentation #1669
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Dec 8, 2020

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 8, 2020
@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Dec 8, 2020
@janiceilene
Copy link
Contributor

Thanks for your patience! Our small team is working our way through reviewing all of the amazing contributions ✨

@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 16, 2020
evic0525
evic0525 previously approved these changes Dec 16, 2020
View reviewed changes
Copy link

@evic0525 evic0525 left a comment

Choose a reason for hiding this comment

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

https://github.com/marketplace/actions/branch-guardian

ayiem
ayiem previously approved these changes Dec 16, 2020
View reviewed changes
Copy link

@ayiem ayiem left a comment

Choose a reason for hiding this comment

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

[email protected]

@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Dec 16, 2020
@timothystone
Copy link
Contributor Author

@janiceilene @ayiem @evic0525 sorry for the late sync/merge/push. resolved conflicts.

@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Dec 31, 2020
@janiceilene janiceilene removed the stale There is no recent activity on this issue or pull request label Jan 4, 2021
@github-actions
Copy link
Contributor

This PR is stale because it has been open 7 days with no activity and will be automatically closed in 3 days. To keep this PR open, update the PR by adding a comment or pushing a commit.

@jcansdale jcansdale dismissed stale reviews from ayiem and evic0525 via 3509c01 March 4, 2021 16:41
@jcansdale
Copy link
Contributor

@timothystone I hope you don't mind. I've pushed a few changes/simplifications to your PR branch. I thought it might accelerate getting this PR merged. 🤞🏻

trent-j
trent-j previously approved these changes Mar 4, 2021
View reviewed changes
Copy link

@trent-j trent-j left a comment

Choose a reason for hiding this comment

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

LGTM

jmarlena
jmarlena approved these changes Mar 4, 2021
View reviewed changes
Copy link
Contributor

@jmarlena jmarlena left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thank you everyone for your contributions here. I just added a product variable. This looks good from a docs team perspective. ⚡

@jmarlena jmarlena added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Mar 4, 2021
@jmarlena jmarlena merged commit 4fcf7ad into github:main Mar 4, 2021
@timothystone
Copy link
Contributor Author

@jmarlena thanks for the edit. apologies for being late to the discussion! I had lost track of this PR amid some work happening in my day job.

@snyk-bot snyk-bot mentioned this pull request Aug 26, 2021
Open
This was referenced Oct 3, 2021
Open
Open
@snyk-bot snyk-bot mentioned this pull request Dec 7, 2022
Open
@snyk-bot snyk-bot mentioned this pull request Jun 7, 2023
Open
@Z-byte-prog Z-byte-prog mentioned this pull request Sep 2, 2023
Closed
@kavirmusic kavirmusic mentioned this pull request Sep 4, 2023
Open
@RhinosF1 RhinosF1 mentioned this pull request Nov 5, 2023
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jmarlena jmarlena jmarlena approved these changes

@ayiem ayiem ayiem left review comments

@trent-j trent-j trent-j left review comments

@evic0525 evic0525 evic0525 left review comments

Assignees

@jmarlena jmarlena

Labels
content This issue or pull request belongs to the Docs Content team ecosystem This issue or pull request should be reviewed by the Docs Ecosystem team packages This issue or pull request should be reviewed by the docs packages team ready to merge This pull request is ready to merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update the Apache Maven Package configuration documentation