Skip to content

Commit

Permalink
feat: add github folder again
Browse files Browse the repository at this point in the history
  • Loading branch information
ApacheTech committed Jul 27, 2024
1 parent c9b51a2 commit 0ab4ee8
Show file tree
Hide file tree
Showing 7 changed files with 268 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# These are supported funding model platforms

github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
patreon: ApacheTechSolutions # Replace with a single Patreon username
open_collective: # Replace with a single Open Collective username
ko_fi: # Replace with a single Ko-fi username
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
liberapay: # Replace with a single Liberapay username
issuehunt: # Replace with a single IssueHunt username
otechie: # Replace with a single Otechie username
custom: [ 'http://amzn.eu/7qvKTFu', 'bit.ly/APGDonate', 'https://www.buymeacoffee.com/Apache' ] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
name: '🐛 Bug Report'
about: Did things not work as expected?
title: "fix: [what is the issue?] in [where is the issue?]"
labels: 'issue: needs-triage'
---

<!---
Thanks for filing an issue 😄 ! Before you submit, please read the following:
Search open/closed issues before submitting. Someone may have reported the same issue before.
-->

# 🐛 Bug Report

<!--- Provide a general summary of the issue here -->

## 💻 Screenshots / Stack Trace

<!-- Please provide steps to reproduce the issue and/or screenshots of the issue, or stack trace results. -->

## 🤔 Expected Behaviour

<!--- Tell us what should happen -->

## 😯 Current Behaviour

<!--- Tell us what happens instead of the expected behaviour -->
<!--- If you are seeing an error, please include the full error message and stack trace -->
<!--- If applicable, provide screenshots -->

## 💁 Possible Solution

<!--- Not obligatory, but suggest a fix/reason for the bug -->
<!--- Please let us know if you'd be willing to contribute the fix; we'd be happy to work with you -->

## 🔦 Context

<!--- How has this issue affected you? What are you trying to accomplish? -->
<!--- Providing context helps us come up with a solution that is most useful in the real world -->

## 🌍 Log Files

<!--- Drag and drop your log files here. %VINTAGE_STORY_DATA%\Logs -->

<!--- client-crash.txt -->
<!--- client-debug.txt -->
<!--- client-main.txt -->

<!--- server-crash.txt -->
<!--- server-debug.txt -->
<!--- server-main.txt -->

## 🌍 Your Environment

<!--- Include as many relevant details as possible about the environment you experienced the bug in -->

* OS & Device: [e.g. MacOS, iOS, Windows, Linux] on [iPhone 7, PC]
* Game Version: [e.g. v1.19.8]
* Mods Version: [e.g. v1.6.9]
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Feature Request
about: Suggest an idea for this project.
title: "[FEATURE]"
labels: enhancement
assignees: ''

---

***Summary:** A user story is an informal, general explanation of a software feature written from the perspective of the end user. Its purpose is to articulate how a software feature will provide value to the customer.*

**Is your feature request related to a problem? If not, why is your feature needed?**

A clear description of what the problem is. Ex. As a Mod Developer, I sometimes find that [...]

**Describe the solution you'd like**

Please take your time, and give as much detail as possible.

**Describe alternatives you've considered**

A clear description of any alternative solutions or features you've considered.

**Additional context**

Add any other context or screenshots about the feature request here.
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/user-story.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: User Story
about: Submit a User Story to add to the backlog.
title: "[USER STORY] - Description"
labels: enhancement
assignees: ''
---

***Summary:** A user story is an informal, general explanation of a software feature written from the perspective of the end user. Its purpose is to articulate how a software feature will provide value to the customer.*

## Examples:

```text
As a user,
Given I am importing waypoints,
When I choose which files to import,
Then I should be able to edit the waypoints, before confirming the import.
As a server admin,
Given I am logged into the game, rather than using the console,
When I use the command, `/adminSettings`.
Then I should be shown a GUI, rather than needing to type all the options.
```

## Your submission:

```text
As
Given
When
Then
```
67 changes: 67 additions & 0 deletions .github/labels.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
[
{
"name": "duplicate",
"color": "F5F5F5",
"description": "This issue or pull request already exists."
},
{
"name": "gantry",
"color": "D6F934",
"description": "This issue or feature involves the Gantry MDK."
},
{
"name": "documentation",
"color": "0075CA",
"description": "Improvements or additions to documentation."
},
{
"name": "issue: needs-triage",
"color": "FEF2C0",
"description": "This is a new issue, and needs some initial triage."
},
{
"name": "issue: needs-feedback",
"color": "FEF2C0",
"description": "This issue has been passed back to the user to add more feedback."
},
{
"name": "issue: needs-investigation",
"color": "FEF2C0",
"description": "This issue has been triaged, and requires further invesigation."
},
{
"name": "issue: under-investigation",
"color": "FEF2C0",
"description": "This issue is currently undergoing a more detailed diagnosis."
},
{
"name": "issue: pending-release",
"color": "FEF2C0",
"description": "This issue has been revolved, and is pending release."
},
{
"name": "issue: resolved",
"color": "FEF2C0",
"description": "This issue has been resolved, and released."
},
{
"name": "enhancement: suggestion",
"color": "006B75",
"description": "Early feature idea and discussion. It is NOT ready for implementation."
},
{
"name": "enhancement: needs-work",
"color": "006B75",
"description": "Feature needs work before it is approved. It is NOT ready for implementation."
},
{
"name": "enhancement: ready-for-review",
"color": "006B75",
"description": "Feature is ready for review. It is NOT ready for implementation."
},
{
"name": "enhancement: approved",
"color": "006B75",
"description": "Feature was approved. It can be implemented."
}
]
52 changes: 52 additions & 0 deletions .github/scripts/sync-labels.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
const fs = require("fs");
const path = ".github/labels.json";
const labels = JSON.parse(fs.readFileSync(path, "utf8"));

// Function to delete all existing labels
async function deleteAllLabels(github, context) {
const existingLabels = await github.rest.issues.listLabelsForRepo({
owner: context.repo.owner,
repo: context.repo.repo
});

for (const label of existingLabels.data) {
await github.rest.issues.deleteLabel({
owner: context.repo.owner,
repo: context.repo.repo,
name: label.name
});
}
}

// Function to add labels from JSON file
async function addLabels(github, context) {
for (const label of labels) {
try {
await github.rest.issues.createLabel({
owner: context.repo.owner,
repo: context.repo.repo,
name: label.name,
color: label.color,
description: label.description
});
} catch (error) {
if (error.status !== 422) { // 422 means unprocessable entity, which could indicate the label already exists.
throw error;
}
}
}
}

module.exports = async ({ github, context }) => {
try {
// Clear existing labels
await deleteAllLabels(github, context);

// Add new labels from JSON
await addLabels(github, context);

console.log("Labels updated successfully.");
} catch (error) {
console.error("Error updating labels:", error);
}
};
19 changes: 19 additions & 0 deletions .github/workflows/manage-labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
name: Manage Labels

on:
workflow_dispatch: # This ensures the workflow runs only when manually triggered

jobs:
sync-labels:
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v2

- name: Sync Labels
uses: actions/github-script@v6
with:
script: |
const script = require('./.github/scripts/sync-labels.js');
script({ github, context });

0 comments on commit 0ab4ee8

Please sign in to comment.