Skip to content

Commit 53f5ed7

Browse files
committed
📝 docs: add details of github actions to pipeline approval workflow
1 parent 9564314 commit 53f5ed7

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

.github/workflows/pipeline_proposals.yml

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -85,22 +85,18 @@ jobs:
8585
}
8686
8787
// Helper function to update issue status and labels
88-
async function updateIssueStatus(status, closeReason = null) {
88+
async function updateIssueStatus(status) {
8989
const labels = [];
90-
let state = 'open';
9190
9291
switch (status) {
9392
case '✅ Approved':
9493
labels.push('accepted');
95-
state = 'closed';
9694
break;
9795
case '❌ Rejected':
9896
labels.push('turned-down');
99-
state = 'closed';
10097
break;
10198
case '⏰ Timed Out':
10299
labels.push('timed-out');
103-
state = 'closed';
104100
break;
105101
default:
106102
labels.push('proposed');
@@ -113,17 +109,6 @@ jobs:
113109
issue_number: issueNumber,
114110
labels: labels
115111
});
116-
117-
// Close the issue if needed
118-
if (state === 'closed') {
119-
await github.rest.issues.update({
120-
owner: org,
121-
repo,
122-
issue_number: issueNumber,
123-
state: 'closed',
124-
state_reason: closeReason || (status === '✅ Approved' ? 'completed' : 'not_planned')
125-
});
126-
}
127112
}
128113
129114
// Handle label changes

README.md

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,30 @@ To make a new proposal for a special interest group, please create a new issue i
2323

2424
The curator workflow is as follows:
2525

26-
- [ ] Once a issue is made, update the 'Project' status to 'proposed' (right hand side bar, under 'new-<TYPE>-proposals')
26+
- [ ] Once a issue is made, a Github Actions workflow will:
27+
- Add the 'proposed' label
28+
- Create a status comment tracking approvals
2729
- [ ] Facilitate discussion on the the Issue thread, following the guidance [here](https://nf-co.re/docs/checklists/community_governance/core_team#new-pipeline-proposals-and-onboarding).
2830
- [ ] Acceptance requires a minimum of OKs from:
2931
- Two members of the core team.
3032
- One member of the core team and one member of the maintainers team.
31-
- [ ] If a proposal is accepted, update both the label AND status to 'accepted', and when closing select 'Close as completed'
32-
- [ ] If a proposal is turned down, update both the label AND status to 'turned-down', and when closing select 'Close as not planned'
33-
- [ ] If a proposal is not completed or abandoned after a year, update both the label AND status to 'timed-out', and when closing select 'Close as not planned'
34-
- [ ] Complete the reemaining new-pipeline onboarding tasks listed [here](https://nf-co.re/docs/checklists/community_governance/core_team#new-pipeline-proposals-and-onboarding)
33+
- [ ] Core and maintainer members can use the following commands in comments:
34+
- `/approve` - to approve the proposal
35+
- `/reject` - to reject the proposal
36+
- [ ] The automation will:
37+
- Track approvals and rejections
38+
- Update the status comment
39+
- Update labels based on the current status
40+
- [ ] If a proposal is accepted:
41+
- Update the status to 'accepted'
42+
- Close the issue as 'completed'
43+
- [ ] If a proposal is turned down:
44+
- Update the status to 'turned-down'
45+
- Close the issue as 'not planned'
46+
- [ ] If a proposal is not completed or abandoned after a year:
47+
- Add the 'timed-out' label
48+
- Close the issue as 'not planned'
49+
- [ ] Complete the remaining new-pipeline onboarding tasks listed [here](https://nf-co.re/docs/checklists/community_governance/core_team#new-pipeline-proposals-and-onboarding)
3550

3651
### Special Interest Groups
3752

0 commit comments

Comments
 (0)