Skip to content

Commit dfcef6a

Browse files
frankpaganfrankpagan
committed
feat: Initial Release
0 parents  commit dfcef6a

13 files changed

+1385
-0
lines changed

‎.github/FUNDING.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# These are supported funding model platforms
2+
3+
github: CoCreate-app

‎.github/workflows/automated.yml

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
name: Automated Workflow
2+
on:
3+
push:
4+
branches:
5+
- master
6+
jobs:
7+
about:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout
11+
uses: actions/checkout@v3
12+
- name: Setup Node.js
13+
uses: actions/setup-node@v3
14+
with:
15+
node-version: 16
16+
- name: Jaid/action-sync-node-meta
17+
uses: jaid/[email protected]
18+
with:
19+
direction: overwrite-github
20+
githubToken: "${{ secrets.GITHUB }}"
21+
release:
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v3
26+
- name: Setup Node.js
27+
uses: actions/setup-node@v3
28+
with:
29+
node-version: 14
30+
- name: Semantic Release
31+
uses: cycjimmy/semantic-release-action@v3
32+
id: semantic
33+
with:
34+
extra_plugins: |
35+
@semantic-release/changelog
36+
@semantic-release/git
37+
@semantic-release/github
38+
env:
39+
GITHUB_TOKEN: "${{ secrets.GITHUB }}"
40+
NPM_TOKEN: "${{ secrets.NPM_TOKEN }}"
41+
outputs:
42+
new_release_published: "${{ steps.semantic.outputs.new_release_published }}"
43+
new_release_version: "${{ steps.semantic.outputs.new_release_version }}"
44+
upload:
45+
runs-on: ubuntu-latest
46+
needs: release
47+
if: needs.release.outputs.new_release_published == 'true'
48+
env:
49+
VERSION: "${{ needs.release.outputs.new_release_version }}"
50+
steps:
51+
- name: Checkout
52+
uses: actions/checkout@v3
53+
- name: Setup Node.js
54+
uses: actions/setup-node@v3
55+
with:
56+
node-version: 16
57+
- name: Set npm registry auth
58+
run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_TOKEN }}" > ~/.npmrc
59+
- name: Install dependencies
60+
run: yarn install
61+
62+
- name: Set Environment Variables
63+
run: |
64+
echo "organization_id=${{ secrets.COCREATE_ORGANIZATION_ID }}" >> $GITHUB_ENV
65+
echo "key=${{ secrets.COCREATE_KEY }}" >> $GITHUB_ENV
66+
echo "host=${{ secrets.COCREATE_HOST }}" >> $GITHUB_ENV
67+
- name: CoCreate Upload
68+
run: coc upload
69+

‎.gitignore

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# ignore
2+
node_modules
3+
dist
4+
.npmrc
5+
yarn.lock
6+
7+
logs
8+
*.log
9+
npm-debug.log*
10+
yarn-debug.log*
11+
yarn-error.log*
12+
lerna-debug.log*
13+
.pnpm-debug.log*

‎CHANGELOG.md

Whitespace-only changes.

‎CONTRIBUTING.md

+96
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
# Contributing to CoCreate-url-uploader
2+
3+
This project is work of [many contributors](https://github.com/CoCreate-app/CoCreate-url-uploader/graphs/contributors).
4+
You're encouraged to submit [pull requests](https://github.com/CoCreate-app/CoCreate-url-uploader/pulls),
5+
[propose features and discuss issues](https://github.com/CoCreate-app/CoCreate-url-uploader/issues).
6+
7+
In the examples below, substitute your Github username for `contributor` in URLs.
8+
9+
## Fork the Project
10+
11+
Fork the [project on Github](https://github.com/CoCreate-app/CoCreate-url-uploader) and check out your copy.
12+
13+
```
14+
git clone https://github.com/contributor/CoCreate-url-uploader.git
15+
cd CoCreate-url-uploader
16+
git remote add upstream https://github.com/CoCreate-app/CoCreate-url-uploader.git
17+
```
18+
19+
## Create a Topic Branch
20+
21+
Make sure your fork is up-to-date and create a topic branch for your feature or bug fix on dev branch.
22+
23+
```
24+
git checkout dev
25+
git pull upstream dev
26+
git checkout -b my-feature-branch
27+
```
28+
29+
## Write Tests
30+
31+
Try to write a test that reproduces the problem you're trying to fix or describes a feature that you want to build.
32+
33+
We definitely appreciate pull requests that highlight or reproduce a problem, even without a fix.
34+
35+
## Write Code
36+
37+
Implement your feature or bug fix.
38+
39+
## Write Documentation
40+
41+
Document any external behavior in the [README](README.md).
42+
43+
## Commit Changes
44+
45+
Make sure git knows your name and email address:
46+
47+
```
48+
git config --global user.name "Your Name"
49+
git config --global user.email "[email protected]"
50+
```
51+
52+
We use [semantic-release](https://github.com/semantic-release/semantic-release) as process to generate changelog
53+
and to release. Write meaningful commits according to
54+
[Commit Message Formats](https://github.com/semantic-release/semantic-release#commit-message-format) is important.
55+
56+
```
57+
git add ...
58+
git commit -am "commit-type(optional topic): a meaningful message"
59+
```
60+
61+
Here is an example of the release type that should be done based on a [semantic-release](https://github.com/semantic-release/semantic-release):
62+
63+
| Commit message | Release type |
64+
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------- |
65+
| `fix(pencil): stop graphite breaking when too much pressure applied` | Patch Release |
66+
| `feat(pencil): add 'graphiteWidth' option` | ~~Minor~~ Feature Release |
67+
| `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 |
68+
69+
## Push
70+
71+
```
72+
git push origin my-feature-branch
73+
```
74+
75+
## Make a Pull Request
76+
77+
Go to [https://github.com/CoCreate-app/CoCreate-url-uploader](https://github.com/CoCreate-app/CoCreate-url-uploader) and select your feature branch.
78+
Click the 'Pull Request' button and fill out the form. Pull requests are usually reviewed within a few days.
79+
80+
## Rebase
81+
82+
If you've been working on a change for a while, rebase with upstream/dev.
83+
84+
```
85+
git fetch upstream
86+
git rebase upstream/dev
87+
git push origin my-feature-branch -f
88+
```
89+
90+
## Be Patient
91+
92+
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!
93+
94+
## Thank You
95+
96+
Please do know that we really appreciate and value your time and work. We love you, really.

‎CoCreate.config.js

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
module.exports = {
2+
"organization_id": "",
3+
"key": "",
4+
"host": "",
5+
"sources": [
6+
{
7+
"array": "files",
8+
"object": {
9+
"_id": "60145dc49f64ba1680b86693",
10+
"name": "index.html",
11+
"path": "/docs/url-uploader",
12+
"pathname": "/docs/url-uploader/index.html",
13+
"src": "{{./docs/index.html}}",
14+
"host": [
15+
"cocreate.app",
16+
"general.cocreate.app"
17+
],
18+
"directory": "url-uploader",
19+
"content-type": "text/html",
20+
"public": "true"
21+
}
22+
}
23+
]
24+
};

0 commit comments

Comments
 (0)