Skip to content

Commit

Permalink
Merge branch 'dev' into dev
Browse files Browse the repository at this point in the history
  • Loading branch information
Kir-Antipov authored Jan 14, 2024
2 parents b5056dd + f8cee9e commit 686aef5
Show file tree
Hide file tree
Showing 109 changed files with 11,729 additions and 4,901 deletions.
1 change: 1 addition & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -200,6 +200,7 @@
"allowObjectStart": true,
"allowArrayStart": true
}],
"@typescript-eslint/no-unsafe-declaration-merging": "off",
"lines-between-class-members": "error",
"max-len": "off",
"max-statements-per-line": "error",
Expand Down
115 changes: 115 additions & 0 deletions .github/ISSUE_TEMPLATE/01_bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
name: Bug report
description: Submit a bug report to help us improve.
title: "[Bug] "
labels: ["bug"]
body:
- type: textarea
id: description
attributes:
label: Description
render: Markdown
description: Please provide a clear and concise description of the problem.
validations:
required: true

- type: textarea
id: expected-behavior
attributes:
label: Expected Behavior
description: Provide a description of the expected behavior.
validations:
required: true

- type: textarea
id: actual-behavior
attributes:
label: Actual Behavior
description: Provide a description of the actual behavior observed.
validations:
required: true

- type: input
id: version
attributes:
label: Version
description: Specify the version of mc-publish you are currently using.
placeholder: |
Please make sure to upgrade to the latest release before opening an issue.
validations:
required: true

- type: dropdown
id: environment
attributes:
label: Environment
description: Specify the environment where you are using mc-publish.
multiple: false
default: 0
options:
- GitHub Actions
- GitLab CI/CD
- Other (Docker)
- Other (Script)
- Other (Executable)
validations:
required: true

- type: textarea
id: configuration
attributes:
label: Configuration
description: Provide the relevant parts of the configuration that caused the problem, if applicable.
placeholder: |
on:
release:
types: [published]
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
# Build artifacts...
- name: Publish assets to GitHub, Modrinth, and CurseForge
uses: Kir-Antipov/[email protected]
with:
name: ""
modrinth-token: ${{ secrets.MODRINTH_TOKEN }}
curseforge-token: ${{ secrets.CURSEFORGE_TOKEN }}
github-token: ${{ secrets.GITHUB_TOKEN }}
render: yml
validations:
required: false

- type: textarea
id: logs
attributes:
label: Logs
description: Copy and paste the relevant logs, if applicable.
placeholder: |
Run Kir-Antipov/[email protected]
with:
modrinth-id: AAAAAAAA
modrinth-token: ***
curseforge-id: 42
curseforge-token: ***
files: build/libs/*.jar
📤 Uploading assets to CurseForge
✅ Successfully published assets to CurseForge in 50000 ms
📤 Uploading assets to Modrinth
Error: Modrinth project "AAAAAAAA" was not found.
render: sh
validations:
required: false

- type: textarea
id: other-information
attributes:
label: Other Information
description: |
If you have an idea about where the problem might lie, how to fix it, whether it's a regression or not, please provide that information here. Include any pointers to code, relevant commits, or related issues that you are aware of.
validations:
required: false
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/02_enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Enhancement
description: Suggest an enhancement for an existing feature.
title: "[Enhancement] "
labels: ["enhancement"]
body:
- type: textarea
id: current-behavior
attributes:
label: Current Behavior
description: |
Provide a description of the current behavior of the feature you want to enhance and explain why it falls short of your expectations.
placeholder: I'm always frustrated when...
validations:
required: false

- type: textarea
id: desired-behavior
attributes:
label: Desired Behavior
description: Please provide a clear and concise description of what you want to happen.
placeholder: It should be possible to...
validations:
required: true

- type: textarea
id: alternative-solutions
attributes:
label: Alternative Solutions
description: Describe any alternatives you have considered, if any.
placeholder: You could also...
validations:
required: false

- type: textarea
id: other-information
attributes:
label: Other Information
description: |
If you have any additional relevant details you would like to share with us, please provide that information here.
validations:
required: false
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/03_feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Feature request
description: Propose a new feature you would like to see as part of this project.
title: "[Feature Request] "
labels: ["enhancement"]
body:
- type: textarea
id: description
attributes:
label: Description
description: Please provide a clear and concise description of the feature you want to be implemented.
placeholder: It should be possible to...
validations:
required: true

- type: textarea
id: alternative-solutions
attributes:
label: Alternative Solutions
description: Describe any alternatives you have considered, if any.
placeholder: You could also...
validations:
required: false

- type: textarea
id: risks
attributes:
label: Risks
description: Please mention any risks that, to your knowledge, this proposal might entail, such as unnecessary complexity growth, breaking changes, performance regressions, etc.
placeholder: This proposal adds a few more inputs to the mc-publish scheme, bringing their total number to 457, which might be a little bit confusing for the end user.
validations:
required: true

- type: textarea
id: other-information
attributes:
label: Other Information
description: |
If you have any additional relevant details you would like to share with us, please provide that information here.
validations:
required: false
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
blank_issues_enabled: true
contact_links:
- name: Discussions
url: https://github.com/Kir-Antipov/mc-publish/discussions
about: |
Please use Issues exclusively for reporting bugs, suggesting enhancements to existing functionality, and requesting new features.
For general questions, assistance requests, and broader community discussions, please visit our GitHub Discussions space.
- name: Documentation
url: https://github.com/Kir-Antipov/mc-publish#mc-publish
about: |
Explore our comprehensive documentation to gain valuable insights into using mc-publish effectively within your workflows.
If you encounter any issues or have suggestions for improving the documentation, feel free to open an issue or participate in our Discussions.
43 changes: 43 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!-- See CONTRIBUTING.md for general guidelines on contributions. -->
<!-- Don't forget to target your pull request exclusively against the `dev` branch. -->

## Description

<!-- What does the pull request do? -->
<!-- Provide background on the PR, including links to related issues, etc. -->

## Current Behavior

<!-- If the PR is a fix, describe the current incorrect behavior. Otherwise, delete this section. -->

## Updated Behavior

<!-- If the PR is a fix, describe the updated/expected behavior. Otherwise, delete this section. -->

## Implementation Notes

<!-- How was the solution implemented (if it's not obvious)? -->
<!-- Include any information that might be useful to a reviewer here, if any. Otherwise, delete this section. -->

## Checklist

- [ ] Added unit tests for every exported function/class.
- [ ] Added JSDoc to every public function/class/class member.
- [ ] Added relevant information to the README.

## Breaking Changes

<!-- List any breaking changes here, if any. Otherwise, delete this section. -->

## Fixed Issues

<!--
If the pull request fixes issue(s), list them like this:
Fixes #123
Fixes #456
Otherwise, delete this section.
-->
30 changes: 30 additions & 0 deletions .github/SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Security Notice

This is the security notice for the [mc-publish](https://github.com/Kir-Antipov/mc-publish) repository. The notice explains how and when vulnerabilities should be reported.

This notice is applicable to the latest release of the project. If you are using an outdated version, please upgrade to the latest release before reporting any issues.

## Reporting a Vulnerability

If you believe you have found a security vulnerability in this project, please send an email to [[email protected]](mailto:[email protected]) with a detailed description of the issue. We will review and respond to all security reports promptly.

We kindly request that you avoid publicly disclosing any security vulnerabilities until we have had an opportunity to address them. We are committed to addressing and resolving reported issues in a responsible and timely manner. Thus, please, **do not** open a GitHub issue for the found vulnerability.

We strive to maintain a secure codebase, and we appreciate the community's help in identifying and addressing security vulnerabilities. Security updates will be released as needed, and we encourage all users to update to the latest version regularly.

## Scope

The following vulnerabilities are considered **within the scope**:

- Unauthorized disclosure of authentication tokens
- Exploitation of authentication tokens by faulty dependencies
- Insecure data storage
- Arbitrary Code Execution (ACE) attacks

The following vulnerabilities are **outside the scope**:

- Outdated dependencies
- Denial of Service (DoS) attacks, including ReDoS, stemming from faulty user input
- Security vulnerabilities in the development environment (unless they directly lead to vulnerabilities in the distributed project)

If you are uncertain whether the vulnerability you have found is within the scope or not, you can still reach out to us via email.
6 changes: 2 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Set up Node.js v16
uses: actions/setup-node@v1
uses: actions/setup-node@v4
with:
node-version: 16

Expand All @@ -20,5 +20,3 @@ jobs:

- name: Execute tests
run: npm run test
env:
CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
Kir_Antipov#4513 (Discord).
`[email protected]`.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
Loading

0 comments on commit 686aef5

Please sign in to comment.