Skip to content

Commit

Permalink
v0.1.0 - boundation, changelog, version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
balupton committed Oct 31, 2023
1 parent f9c982a commit a2878bc
Show file tree
Hide file tree
Showing 30 changed files with 4,499 additions and 1,564 deletions.
4 changes: 2 additions & 2 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# 2018 September 26
# 2023 June 22
# https://github.com/bevry/base

root = true
Expand All @@ -18,7 +18,7 @@ indent_size = 4
indent_style = space
indent_size = 4

[{*.json,*.lsrules,*.yml,*.bowerrc,*.babelrc}]
[{*.json,*.lsrules,*.yaml,*.yml,*.bowerrc,*.babelrc,*.code-workspace}]
indent_style = space
indent_size = 2

Expand Down
6 changes: 6 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
github: [balupton]
patreon: bevry
open_collective: bevry
ko_fi: balupton
liberapay: bevry
custom: ['https://bevry.me/fund']
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: 2
updates:
- package-ecosystem: npm
directory: /
schedule:
interval: weekly
day: sunday
11 changes: 11 additions & 0 deletions .github/workflows/automerge.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: automerge
'on':
- pull_request
jobs:
automerge:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: ahmadnassri/action-dependabot-auto-merge@v2
with:
github-token: ${{ secrets.DEPENDABOT_AUTOMERGE_GITHUB_TOKEN }}
48 changes: 48 additions & 0 deletions .github/workflows/bevry.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: bevry
'on':
- push
- pull_request
jobs:
test:
strategy:
matrix:
os:
- ubuntu-latest
node:
- '18'
- '20'
- '21'
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v2
- name: Install desired Node.js version
uses: actions/setup-node@v2
with:
node-version: '20'
- run: npm run our:setup
- run: npm run our:compile
- run: npm run our:verify
- name: Install targeted Node.js
if: ${{ matrix.node != 20 }}
uses: actions/setup-node@v2
with:
node-version: ${{ matrix.node }}
- run: npm test
publish:
if: ${{ github.event_name == 'push' }}
needs: test
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Install desired Node.js version
uses: actions/setup-node@v2
with:
node-version: '20'
- run: npm run our:setup
- run: npm run our:compile
- run: npm run our:meta
- name: publish to surge
uses: bevry-actions/[email protected]
with:
surgeLogin: ${{ secrets.SURGE_LOGIN }}
surgeToken: ${{ secrets.SURGE_TOKEN }}
68 changes: 0 additions & 68 deletions .npmignore

This file was deleted.

57 changes: 57 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# 2023 March 24
# https://github.com/bevry/base

# VCS Files
.git
.svn
.hg

# System Files
**/.DS_Store

# Temp Files
**/.docpad.db
**/*.log
**/*.cpuprofile
**/*.heapsnapshot

# Yarn Files
.yarn/*
!.yarn/releases
!.yarn/plugins
!.yarn/sdks
!.yarn/versions
.pnp.*
.pnp/

# Build Caches
build/
components/
bower_components/
node_modules/

# Build Outputs
**/out.*
**/*.out.*
**/out/
**/output/
*compiled*
edition*/
coffeejs/
coffee/
es5/
es2015/
esnext/
docs/

# Development Files
test/
**/*fixtures*

# Ecosystem Caches
.trunk/*/

# =====================================
# CUSTOM

# None
118 changes: 118 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
<!--
2020 March 26
https://github.com/bevry/base
-->

# Before You Post!

## Support

We offer support through our [Official Support Channels](https://bevry.me/support). Do not use GitHub Issues for support, your issue will be closed.

## Contribute

Our [Contributing Guide](https://bevry.me/contribute) contains useful tips and suggestions for how to contribute to this project, it's worth the read.

## Development

### Setup

1. [Install Node.js](https://bevry.me/install/node)

1. Fork the project and clone your fork - [guide](https://help.github.com/articles/fork-a-repo/)

1. Setup the project for development

```bash
npm run our:setup
```

### Developing

1. Compile changes

```bash
npm run our:compile
```

1. Run tests

```bash
npm test
```

### Publishing

Follow these steps in order to implement your changes/improvements into your desired project:

#### Preparation

1. Make sure your changes are on their own branch that is branched off from master.

1. You can do this by: `git checkout master; git checkout -b your-new-branch`
1. And push the changes up by: `git push origin your-new-branch`

1. Ensure all tests pass:

```bash
npm test
```

> If possible, add tests for your change, if you don't know how, mention this in your pull request

1. Ensure the project is ready for publishing:

```
npm run our:release:prepare
```

#### Pull Request

To send your changes for the project owner to merge in:

1. Submit your pull request
1. When submitting, if the original project has a `dev` or `integrate` branch, use that as the target branch for your pull request instead of the default `master`
1. By submitting a pull request you agree for your changes to have the same license as the original plugin

#### Publish

To publish your changes as the project owner:

1. Switch to the master branch:

```bash
git checkout master
```

1. Merge in the changes of the feature branch (if applicable)

1. Increment the version number in the `package.json` file according to the [semantic versioning](http://semver.org) standard, that is:

1. `x.0.0` MAJOR version when you make incompatible API changes (note: DocPad plugins must use v2 as the major version, as v2 corresponds to the current DocPad v6.x releases)
1. `x.y.0` MINOR version when you add functionality in a backwards-compatible manner
1. `x.y.z` PATCH version when you make backwards-compatible bug fixes

1. Add an entry to the changelog following the format of the previous entries, an example of this is:

```markdown
## v6.29.0 2013 April 1
- Progress on [issue #474](https://github.com/docpad/docpad/issues/474)
- DocPad will now set permissions based on the process's ability
- Thanks to [Avi Deitcher](https://github.com/deitch), [Stephan Lough](https://github.com/stephanlough) for [issue #165](https://github.com/docpad/docpad/issues/165)
- Updated dependencies
```
1. Commit the changes with the commit title set to something like `v6.29.0. Bugfix. Improvement.` and commit description set to the changelog entry
1. Ensure the project is ready for publishing:
```
npm run our:release:prepare
```
1. Prepare the release and publish it to npm and git:
```bash
npm run our:release
```
9 changes: 9 additions & 0 deletions HISTORY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# History

## v0.1.0 2023 November 1

- Updated dependencies, [base files](https://github.com/bevry/base), and [editions](https://editions.bevry.me) using [boundation](https://github.com/bevry/boundation)

## v1.0.0 2015 October 25

- Some feature
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@

<!-- BADGES/ -->

<span class="badge-githubworkflow"><a href="https://github.com/bevry/coda-packs/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/coda-packs/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span>
<br class="badge-separator" />
<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/balupton" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
Expand Down Expand Up @@ -41,6 +44,7 @@ These amazing people are maintaining this project:
No sponsors yet! Will you be the first?

<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/balupton" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
Expand All @@ -56,7 +60,7 @@ These amazing people have contributed code to this project:

<ul><li><a href="https://github.com/balupton">Benjamin Lupton</a> — <a href="https://github.com/bevry/coda-packs/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/coda-packs">view contributions</a></li></ul>


<a href="https://github.com/bevry/coda-packs/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>

<!-- /BACKERS -->

Expand Down
Loading

0 comments on commit a2878bc

Please sign in to comment.