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

Internal: Enhance GitHub Workflow documentation #2147

Closed
7 of 22 tasks
jprestop opened this issue Apr 27, 2023 · 1 comment · Fixed by #2185
Closed
7 of 22 tasks

Internal: Enhance GitHub Workflow documentation #2147

jprestop opened this issue Apr 27, 2023 · 1 comment · Fixed by #2185
Assignees
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue component: release engineering Release engineering issue priority: low Low Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Milestone

Comments

@jprestop
Copy link
Collaborator

jprestop commented Apr 27, 2023

Describe the Task

Enhance the GitHub Workflow documentation by adding information about how the Cycle selection can only be added after the Issue is created and how the Cycle and Issue selection can only be added after the PR is created.

Use the following for PRs from George from Slack in the "Open a pull request" section:

  1. Before the pull request is created, one can select the development project, but cannot select a cycle:
  2. After the PR is created, more options appear until the Project section:
  3. Click the status pull down and select "Review":
  4. Click on "+1 more" then click "Choose an iteration" under "Cycle" and select the current development cycle:
  5. Click on the gear next to "Development," type the issue number that corresponds to the work, then select the issue that is displayed:

For Issues (potentially modify the “Find the GitHub issue” section to be “Find the or Create a GitHub issue” section):

  1. Before the issue is created, one can select the development project, but cannot select a cycle:
  2. After the PR is created, more options appear until the Project section:
  3. Click the status pull down and select "Review":
  4. Click on "+1 more" then click "Choose an iteration" under "Cycle" and select the current development cycle:

Time Estimate

Estimate the amount of work required here.
<1 day

Sub-Issues

Consider breaking the task down into sub-issues.

  • Add a checkbox for each sub-issue here.

Relevant Deadlines

None

Funding Source

Request is in for Tara to assign; Waiting to hear back.

Define the Metadata

Assignee

  • Select engineer(s) or no engineer required
  • Select scientist(s) or no scientist required

Labels

  • Select component(s)
  • Select priority
  • Select requestor(s)

Projects and Milestone

  • Select Repository and/or Organization level Project(s) or add alert: NEED CYCLE ASSIGNMENT label
  • Select Milestone as the next official version or Future Versions

Define Related Issue(s)

Consider the impact to the other METplus components.

Task Checklist

See the METplus Workflow for details.

  • Complete the issue definition above, including the Time Estimate and Funding Source.
  • Fork this repository or create a branch of develop.
    Branch name: feature_<Issue Number>_<Description>
  • Complete the development and test your changes.
  • Add/update log messages for easier debugging.
  • Add/update unit tests.
  • Add/update documentation.
  • Add any new Python packages to the METplus Components Python Requirements table.
  • Push local changes to GitHub.
  • Submit a pull request to merge into develop.
    Pull request: feature <Issue Number> <Description>
  • Define the pull request metadata, as permissions allow.
    Select: Reviewer(s) and Development issues
    Select: Repository level development cycle Project for the next official release
    Select: Milestone as the next official version
  • Iterate until the reviewer(s) accept and merge your changes.
  • Delete your fork or branch.
  • Close this issue.
@jprestop jprestop added component: documentation Documentation issue priority: low Low Priority type: task An actionable item of work component: release engineering Release engineering issue alert: NEED MORE DEFINITION Not yet actionable, additional definition required alert: NEED ACCOUNT KEY Need to assign an account key to this issue requestor: METplus Team METplus Development Team labels Apr 27, 2023
@jprestop jprestop added this to the METplus-5.1.0 milestone Apr 27, 2023
@jprestop
Copy link
Collaborator Author

issue.tar.txt
pr.tar.txt
Uploading tar files of images (renamed with txt extension) to use for instructions.

@georgemccabe georgemccabe changed the title Enhance GitHub Workflow documentation Documentation: Enhance GitHub Workflow documentation May 10, 2023
@jprestop jprestop removed the alert: NEED MORE DEFINITION Not yet actionable, additional definition required label May 23, 2023
@jprestop jprestop linked a pull request May 23, 2023 that will close this issue
13 tasks
@georgemccabe georgemccabe changed the title Documentation: Enhance GitHub Workflow documentation Internal: Enhance GitHub Workflow documentation Jun 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
alert: NEED ACCOUNT KEY Need to assign an account key to this issue component: documentation Documentation issue component: release engineering Release engineering issue priority: low Low Priority requestor: METplus Team METplus Development Team type: task An actionable item of work
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

2 participants