Skip to content

Commit

Permalink
build: updated gobstones-scripts to 0.8.0
Browse files Browse the repository at this point in the history
This implies minimal changes in documentation, husky and other build processes.
  • Loading branch information
alanrodas committed Apr 5, 2024
1 parent ffb0f34 commit 167c2df
Show file tree
Hide file tree
Showing 22 changed files with 465 additions and 30 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve

---

Before opening a new issue, please take a moment to review our [**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the contribution process easy and effective for everyone involved.

## Description
A clear and concise description of what the bug is.

## Steps to reproduce
Steps to reproduce the behavior:

(Add link to a demo on https://jsfiddle.net or similar if possible)

**Expected behavior**
A clear and concise description of what you expected to happen.


## Versions

- Library Version:
- Node/NPM Version (if any):
- Operating System Version:
- Browser Version:
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Feature request
about: Suggest an idea for this project

---

Before opening a new feature request, please take a moment to review our [**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the contribution process easy and effective for everyone involved.

More specifically, see our **roadmap** to be aware if the feature you are considering is already planned. If you still considere the feature is worth requesting, please complete the following:

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
28 changes: 28 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Gobstones

Thank you for contributing! Please take a moment to review our
[**guidelines**](https://github.com/gobstones/gobstones-guidelines) to make the
process easy and effective for everyone involved.

**Please open an issue** before embarking on any significant pull request,
especially those that add a new library or change existing tests, otherwise you
risk spending a lot of time working on something that might not end up being
merged into the project.

Before opening a pull request, please ensure:

- [ ] You have followed our [**guidelines**](https://github.com/gobstones/gobstones-guidelines)
- [ ] Double-check your branch is based on `main` and targets `main`
- [ ] Pull request has tests (we are going for 100% coverage!)
- [ ] Code is well-commented, linted and follows project conventions
- [ ] Documentation is updated (if necessary)
- [ ] Internal code generators and templates are updated (if necessary)
- [ ] Description explains the issue/use-case resolved and auto-closes related
issues

Be kind to code reviewers, please try to keep pull requests as small and focused
as possible.

**IMPORTANT**: By submitting a patch, you agree to allow the project
owners to license your work under the terms of our
[License](https://github.com/gobstones/gobstones-guidelines/blob/main/LICENSE).
Binary file added .github/favicon.ico
Binary file not shown.
13 changes: 13 additions & 0 deletions .github/issue-close-app.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
comment: This issue was automatically closed because it does not follow either one of our templates. Please open a new issue and fill out the template that appears instead of deleting it. If you're reporting an issue, it's especially important that you provide detailed steps for how to reproduce it.

issueConfigs:
- content:
- Description
- Steps to reproduce
- Versions

- content:
- Is your feature request related to a problem
- Describe the solution you'd like
- Describe alternatives you've considered
- Additional context
28 changes: 28 additions & 0 deletions .github/lock.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Configuration for lock-threads - https://github.com/dessant/lock-threads

# Number of days of inactivity before a closed issue or pull request is locked
daysUntilLock: 30

# Issues and pull requests with these labels will not be locked. Set to `[]` to disable
exemptLabels: []

# Label to add before locking, such as `outdated`. Set to `false` to disable
lockLabel: 'Auto-Closed'

# Comment to post before locking. Set to `false` to disable
lockComment: >
This thread has been automatically locked since there has not been
any recent activity after it was closed. Please open a new issue for
related bugs.
# Limit to only `issues` or `pulls`
only: issues
# Optionally, specify configuration settings just for `issues` or `pulls`
# issues:
# exemptLabels:
# - help-wanted
# lockLabel: outdated

# pulls:
# daysUntilLock: 30

25 changes: 25 additions & 0 deletions .github/workflows/on-commit-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: on-commit-build
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
test:
name: Run tests
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup node version
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Installing project dependencies
run: npm install
- name: Build the code
run: npm start build
env:
CI: true
43 changes: 43 additions & 0 deletions .github/workflows/on-tag-publish-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: on-tag-publish-docs

on:
push:
tags:
- 'v*'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: 'pages'
cancel-in-progress: false

jobs:
publish-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup node version
uses: actions/setup-node@v4
with:
node-version: '20'
- name: Installing project dependencies
run: npm install
- name: Building the docs
run: npm start doc
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
31 changes: 31 additions & 0 deletions .github/workflows/on-tag-release-github.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: on-tag-release-github

on:
push:
tags:
- 'v*'

jobs:
publish-into-github:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup node version
uses: actions/setup-node@v4
with:
node-version: '20'
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Installing project dependencies
run: npm install
- name: Building the project
run: npm start build
- name: Create Release on GitHub
uses: ncipollo/release-action@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ github.ref_name }}
name: Release ${{ github.ref_name }}
allowUpdates: true
body: ${{ github.event.head_commit.message }}
28 changes: 28 additions & 0 deletions .github/workflows/on-tag-release-npm.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: on-tag-release-npm

on:
push:
tags:
- 'v*'

jobs:
publish-into-npm:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Setup node version
uses: actions/setup-node@v4
with:
node-version: '20'
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
- name: Installing project dependencies
run: npm install
- name: Building the project
run: npm start build
- name: Publishing to NPM
uses: JS-DevTools/npm-publish@v3
with:
token: ${{ secrets.NPM_TOKEN }}
access: 'public'
17 changes: 14 additions & 3 deletions .gitignore
100644 → 100755
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# OS generated files #
# OS generated files
.DS_Store
Thumbs.db
.tmp/

# IDE generated file #
# IDE generated file
.idea/

# PackageManager specific lock files
Expand All @@ -16,5 +16,16 @@ node_modules/
npm-debug.log
yarn-error.log

# Gnerated folder for site
# Build process generated files
.rollup.cache
tsconfig.build.json

# Test coverage generated folder
coverage/

# Dist generated folder
dist/

# Docs generated folder
docs/

4 changes: 4 additions & 0 deletions .husky/pre-commit
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,9 @@ npx --no gobstones-scripts run changelog --silent ;
echo "\nAdd generated files to commit\n";
git add --all;

# Run license
echo "\nAdd license text to code files\n";
npx --no gobstones-scripts run license --silent ;

# Exit
exit 0;
23 changes: 23 additions & 0 deletions .prettierignore
100644 → 100755
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Node files #
node_modules/
npm-debug.log
yarn-error.log
.rollup.cache

# OS generated files #
.DS_Store
Thumbs.db
.tmp/

# Dist #
dist/
coverage/
tsconfig.build.json

# IDE #
.idea/

# PackageManager specific #
pnpm-lock.yaml
package-lock.json
yarn.lock

0 comments on commit 167c2df

Please sign in to comment.