-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit b0d9d8d
Showing
13 changed files
with
1,444 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# These are supported funding model platforms | ||
|
||
github: CoCreate-app |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
name: Automated Workflow | ||
on: | ||
push: | ||
branches: | ||
- master | ||
jobs: | ||
about: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 16 | ||
- name: Jaid/action-sync-node-meta | ||
uses: jaid/action-sync-node-meta@v1.4.0 | ||
with: | ||
direction: overwrite-github | ||
githubToken: "${{ secrets.GITHUB }}" | ||
release: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 14 | ||
- name: Semantic Release | ||
uses: cycjimmy/semantic-release-action@v3 | ||
id: semantic | ||
with: | ||
extra_plugins: | | ||
@semantic-release/changelog | ||
@semantic-release/git | ||
@semantic-release/github | ||
env: | ||
GITHUB_TOKEN: "${{ secrets.GITHUB }}" | ||
NPM_TOKEN: "${{ secrets.NPM_TOKEN }}" | ||
outputs: | ||
new_release_published: "${{ steps.semantic.outputs.new_release_published }}" | ||
new_release_version: "${{ steps.semantic.outputs.new_release_version }}" | ||
upload: | ||
runs-on: ubuntu-latest | ||
needs: release | ||
if: needs.release.outputs.new_release_published == 'true' | ||
env: | ||
VERSION: "${{ needs.release.outputs.new_release_version }}" | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v3 | ||
- name: Setup Node.js | ||
uses: actions/setup-node@v3 | ||
with: | ||
node-version: 16 | ||
- name: Set npm registry auth | ||
run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc | ||
- name: Install dependencies | ||
run: yarn install | ||
|
||
- name: Set Environment Variables | ||
run: | | ||
echo "organization_id=${{ secrets.COCREATE_ORGANIZATION_ID }}" >> $GITHUB_ENV | ||
echo "key=${{ secrets.COCREATE_KEY }}" >> $GITHUB_ENV | ||
echo "host=${{ secrets.COCREATE_HOST }}" >> $GITHUB_ENV | ||
- name: CoCreate Upload | ||
run: coc upload | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
# ignore | ||
node_modules | ||
dist | ||
.npmrc | ||
yarn.lock | ||
package-lock.json | ||
|
||
logs | ||
*.log | ||
npm-debug.log* | ||
yarn-debug.log* | ||
yarn-error.log* | ||
lerna-debug.log* | ||
.pnpm-debug.log* |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,96 @@ | ||
# Contributing to CoCreate-usage | ||
|
||
This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-usage/graphs/contributors). | ||
You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-usage/pulls), | ||
[propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-usage/issues). | ||
|
||
In the examples below, substitute your Github username for `contributor` in URLs. | ||
|
||
## Fork the Project | ||
|
||
Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-usage) and check out your copy. | ||
|
||
``` | ||
git clone https://github.com/contributor/CoCreate-usage.git | ||
cd CoCreate-usage | ||
git remote add upstream https://github.com/CoCreate-app/CoCreate-usage.git | ||
``` | ||
|
||
## Create a Topic Branch | ||
|
||
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix on dev branch. | ||
|
||
``` | ||
git checkout dev | ||
git pull upstream dev | ||
git checkout -b my-feature-branch | ||
``` | ||
|
||
## Write Tests | ||
|
||
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build. | ||
|
||
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix. | ||
|
||
## Write Code | ||
|
||
Implement your feature or bug fix. | ||
|
||
## Write Documentation | ||
|
||
Document any external behavior in the [README](README.md). | ||
|
||
## Commit Changes | ||
|
||
Make sure git knows your name and email address: | ||
|
||
``` | ||
git config --global user.name "Your Name" | ||
git config --global user.email "contributor@example.com" | ||
``` | ||
|
||
We use [semantic-release](https://github.com/semantic-release/semantic-release) as process to generate changelog | ||
and to release. Write meaningful commits according to | ||
[Commit Message Formats](https://github.com/semantic-release/semantic-release#commit-message-format) is important. | ||
|
||
``` | ||
git add ... | ||
git commit -am "commit-type(optional topic): a meaningful message" | ||
``` | ||
|
||
Here is an example of the release type that should be done based on a [semantic-release](https://github.com/semantic-release/semantic-release): | ||
|
||
| Commit message | Release type | | ||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- | | ||
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release | | ||
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release | | ||
| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release | | ||
|
||
## Push | ||
|
||
``` | ||
git push origin my-feature-branch | ||
``` | ||
|
||
## Make a Pull Request | ||
|
||
Go to [https://github.com/CoCreate-app/CoCreate-usage](https://github.com/CoCreate-app/CoCreate-usage) and select your feature branch. | ||
Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days. | ||
|
||
## Rebase | ||
|
||
If you've been working on a change for a while, rebase with upstream/dev. | ||
|
||
``` | ||
git fetch upstream | ||
git rebase upstream/dev | ||
git push origin my-feature-branch -f | ||
``` | ||
|
||
## Be Patient | ||
|
||
It's likely that your change will not be merged and that the nitpicky maintainers will ask you to do more, or fix seemingly benign problems. Hang in there! | ||
|
||
## Thank You | ||
|
||
Please do know that we really appreciate and value your time and work. We love you, really. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
module.exports = { | ||
"organization_id": "", | ||
"key": "", | ||
"host": "", | ||
"sources": [ | ||
{ | ||
"array": "files", | ||
"object": { | ||
"_id": "6204253780b409001727b73f", | ||
"name": "index.html", | ||
"path": "/docs/usage", | ||
"pathname": "/docs/usage/index.html", | ||
"src": "{{./docs/index.html}}", | ||
"host": [ | ||
"*" | ||
], | ||
"directory": "usage", | ||
"content-type": "text/html", | ||
"public": "true" | ||
} | ||
} | ||
] | ||
}; |
Oops, something went wrong.