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 support for forks #50

Closed
wants to merge 9 commits into from
Closed

Add support for forks #50

wants to merge 9 commits into from

Conversation

SirSpidey
Copy link
Member

Description

See a comment in the internal issue #3813 for a link to where this draft is published internally.


Info about contributing a new module still uses a clone. Let me know if the workflow will instead be that the contributor forks the module that we create.


  • Adds a topic that describes how to fork a repo to update it.
  • Content that is now reused is moved to include files.
  • Changes title of topic about updating an older module to Porting to distinguish from new topic.

Release required?

  • No release
  • Patch release (x.x.X)
  • Minor release (x.X.x)
  • Major release (X.x.x)
Release notes content

Run the pipeline

If the CI pipeline doesn't run when you create the PR, the PR requires a user with GitHub collaborators access to run the pipeline.

Run the CI pipeline when the PR is ready for review and you expect tests to pass. Add a comment to the PR with the following text:

/run pipeline

Checklist for reviewers

  • If relevant, a test for the change is included or updated with this PR.
  • If relevant, documentation for the change is included or updated with this PR.

For mergers

  • Use a conventional commit message to set the release level. Follow the guidelines.
  • Include information that users need to know about the PR in the commit message. The commit message becomes part of the GitHub release notes.
  • Use the Squash and merge option.

Adds a topic that describes how to fork a repo to update it.

Content that is now reused is moved to `inc`lude files.

Change title of topic about updating an older module to `Porting` to distinguish from new topic.
SirSpidey and others added 6 commits October 16, 2023 15:18
Fix link to reference architecture template
Adds a topic that describes how to fork a repo to update it.

Content that is now reused is moved to `inc`lude files.

Change title of topic about updating an older module to `Porting` to distinguish from new topic.
- Recombine creating and updating a module as before
- Update dev setup and migrate-module to support forks
- Remove unused include files
@SirSpidey
Copy link
Member Author

@daniel-butler-irl: Recombined the contributing topic to support both new modules and updating modules. Removed the step when forking to Copy the main branch only.

You can see the internal version at https://pages.github.ibm.com/allen-dean/tim-docs/#/contribute-module

@daniel-butler-irl
Copy link
Member

Great, looks good now. One thing I saw is, we now have a doc gap. Not sure if it goes in this PR. Now we accept forks it means external contributors can contribute. These users will not have access to trigger the pipeline. The Open pull request section needs to be updated to state, if you are a member of github-collaborators you can trigger the pipeline. Then the next part we need to figure out is for external contributors maybe ask to notify @terraform-ibm-modules/github-admins @ocofaigh what do you think about this?

@SirSpidey SirSpidey dismissed daniel-butler-irl’s stale review October 20, 2023 13:15

The merge-base changed after approval.

@SirSpidey SirSpidey dismissed daniel-butler-irl’s stale review October 20, 2023 15:12

The merge-base changed after approval.

@daniel-butler-irl daniel-butler-irl removed the request for review from ocofaigh October 20, 2023 15:13
@daniel-butler-irl daniel-butler-irl dismissed their stale review October 20, 2023 15:13

The merge-base changed after approval.

@daniel-butler-irl daniel-butler-irl dismissed their stale review October 20, 2023 15:13

The merge-base changed after approval.

@daniel-butler-irl daniel-butler-irl requested review from daniel-butler-irl and removed request for ocofaigh October 20, 2023 15:18
@SirSpidey SirSpidey dismissed daniel-butler-irl’s stale review October 20, 2023 15:18

The merge-base changed after approval.

@SirSpidey SirSpidey dismissed daniel-butler-irl’s stale review October 23, 2023 10:27

The merge-base changed after approval.

@SirSpidey SirSpidey dismissed daniel-butler-irl’s stale review October 23, 2023 10:46

The merge-base changed after approval.

@SirSpidey SirSpidey dismissed daniel-butler-irl’s stale review October 23, 2023 10:54

The merge-base changed after approval.

ocofaigh
ocofaigh previously approved these changes Oct 23, 2023
@SirSpidey SirSpidey dismissed ocofaigh’s stale review October 23, 2023 12:36

The merge-base changed after approval.

@SirSpidey
Copy link
Member Author

Closed in favor of #52 because this PR keeps dismissing reviews.

@SirSpidey SirSpidey closed this Oct 23, 2023
@SirSpidey SirSpidey deleted the fork-support branch October 23, 2023 15:55
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