Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release 0.3.17 (template updates) - ?? #1076

Merged
merged 24 commits into from Feb 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE.md
@@ -1,3 +1,19 @@
**Marked version:**

<!-- The NPM version or commit hash having the issue -->

<!--

If submitting something other than a defect with Marked itself, please use the following:

**Proposal type:** new feature | project operations | other

## What pain point are you perceiving?

## What solution are you suggesting?

-->

## Expectation

<!-- Describe the output you are expecting from marked -->
Expand All @@ -9,3 +25,10 @@
## What was attempted

<!-- Describe what code combination got you there -->

<!--
If error is thrown add the following:

## Call stack & console log

-->
58 changes: 41 additions & 17 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,25 +1,49 @@

<!--

If release PR, add ?template=release.md to the PR url to use the release PR template.

Otherwise, you are stating the this PR fixes an issue that has been submitted; or,
describes the issue or proposal under considersation.

-->

**Marked version:**

<!-- The NPM version or commit hash having the issue -->

## Description

<!-- describe what the PR does -->
- Fixes #### (if fixing a known issue; otherwise, describe issue using the following format)

<!--

## Expectation

Describe the output you are expecting from marked

## Result

Describe the output you received from marked

## What was attempted

- Fixes ####
- Fixes list issues fixed by this PR
- Fixes will automatically close them once merged
Describe what code combination got you there

## Review
-->

### Submitter
## Contributor

- [ ] All tests pass (CI should take care of this, once in place).
- [ ] All lint checks pass (CI should take care of this, once in place).
- Tests
- [ ] Test(s) exist to ensure functionality works (if no new tests added, list which tests cover this functionality).
- [ ] No tests required for this PR.
- [ ] Is release:
- [ ] Version in `package.json` has been updated (see [RELEASE.md](https://github.com/markedjs/marked/blob/master/RELEASE.md)).
- [ ] The `marked.min.js` has been updated; or,
- [ ] release does not change library.
- [ ] Test(s) exist to ensure functionality and minimize regresstion (if no tests added, list tests covering this PR); or,
- [ ] no tests required for this PR.
- [ ] If submitting new feature, it has been documented in the appropriate places.

## Committer

### Reviewer
In most cases, this should be a different person than the contributor.

??
- [ ] Draft GitHub release notes have been updated.
- [ ] cm_autolinks is the only failing test (remove once CI is in place and all tests pass).
- [ ] All lint checks pass (remove once CI is in place).
- [ ] CI is green (no forced merge required).
- [ ] Merge PR
26 changes: 26 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/release.md
@@ -0,0 +1,26 @@
## Publisher

- [ ] `$ npm version` has been run.
- [ ] Release notes in [draft GitHub release](https://github.com/markedjs/marked/releases) are up to date
- [ ] Reviewer checklist is complete.
- [ ] Merge PR.
- [ ] Publish GitHub release using `master` with correct version number.
- [ ] `$ npm publish` has been run.
- [ ] Create draft GitHub release to prepare next release.

Note: If merges to `master` occur after submitting this PR and before running `$ npm pubish` you should be able to

1. pull from `upstream/master` (`git pull upstream master`) into the branch holding this version,
2. run `$ npm run build` to regenerate the `min` file, and
3. commit and push the updated changes.

## Committer

In most cases, this should be someone different than the publisher.

- [ ] Version in `package.json` has been updated (see [RELEASE.md](https://github.com/markedjs/marked/blob/master/RELEASE.md)).
- [ ] The `marked.min.js` has been updated; or,
- [ ] release does not change library.
- [ ] cm_autolinks is the only failing test (remove once CI is in place and all tests pass).
- [ ] All lint checks pass (remove once CI is in place).
- [ ] CI is green (no forced merge required).
1 change: 1 addition & 0 deletions AUTHORS.md
Expand Up @@ -12,6 +12,7 @@ Contributors are users who submit a [PR](https://github.com/markedjs/marked/pull

To be listed here, just make a contribution and, if it has significant impact, the committers may be able to add you here. If you're name is here, and you would rather it not be, just let us know.

- Karen Yavine @karenyavine - Thank you for helping keep us out of the security penalyt box!
- Jamie Davis @davisjam - Thank you for the security-related contributions!
- Костя Третяк @KostyaTretyak

Expand Down
2 changes: 1 addition & 1 deletion marked.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Expand Up @@ -2,7 +2,7 @@
"name": "marked",
"description": "A markdown parser built for speed",
"author": "Christopher Jeffrey",
"version": "0.3.15",
"version": "0.3.17",
"main": "./lib/marked.js",
"bin": "./bin/marked",
"man": "./man/marked.1",
Expand Down Expand Up @@ -42,7 +42,7 @@
"bench": "node test --bench",
"lint": "eslint --fix lib/marked.js test/index.js",
"build": "uglifyjs lib/marked.js -cm --comments /Copyright/ -o marked.min.js",
"preversion": "npm run build"
"preversion": "npm run build && (git diff --quiet || git commit -am 'minify')"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what's this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was a recommendation from @UziTech. Basically instead of build then commit min...let NPM + Git do it for us. As far as the details of what Git is actually doing I would have to read the docs.

},
"engines": {
"node": ">=0.10.0"
Expand Down