Skip to content

Commit

Permalink
Rename Changelog.txt to History.md
Browse files Browse the repository at this point in the history
  • Loading branch information
fatso83 committed Sep 18, 2017
1 parent 40edb3e commit e9f40a2
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 6 deletions.
File renamed without changes.
4 changes: 2 additions & 2 deletions RELEASE.md
Expand Up @@ -5,7 +5,7 @@ You will need a working installation of [git-extras](https://github.com/tj/git-e
The release process is mostly automated, here is a brief overview of the steps

1. `npm version [keyword]`
- Updates `Changelog.txt` - you will need to edit this
- Updates `History.md` - you will need to edit this
- Updates `AUTHORS`
- Updates `package.json` with new version
- Creates a new git tag
Expand All @@ -29,7 +29,7 @@ If you absolutely **have** to, then you can also specify a specific version:
npm version x.y.z
```

After this, your default editor will show the updated `Changelog.txt`. Please make edits to this to remove service commits (like updating `devDependencies`) and commits that only change documentation.
After this, your default editor will show the updated `History.md`. Please make edits to this to remove service commits (like updating `devDependencies`) and commits that only change documentation.

## 2. Publish to NPM

Expand Down
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -82,7 +82,7 @@
"pkg",
"AUTHORS",
"CONTRIBUTING.md",
"Changelog.txt",
"History.md",
"LICENSE",
"README.md"
],
Expand Down
4 changes: 2 additions & 2 deletions scripts/preversion.sh
@@ -1,10 +1,10 @@
#!/bin/bash
echo 'Updating Changelog.txt'
echo 'Updating History.md'
git changelog --no-merges
git add Changelog.txt

This comment has been minimized.

Copy link
@fatso83

fatso83 Oct 5, 2017

Author Contributor

Damn, forgot this.


echo 'Updating AUTHORS'
git authors --list > AUTHORS
git add AUTHORS

git commit -m "Update Changelog.txt and AUTHORS for new release"
git commit -m "Update History.md and AUTHORS for new release"
2 changes: 1 addition & 1 deletion scripts/update-changelog-page.sh
Expand Up @@ -5,5 +5,5 @@ title: Changelog
permalink: /releases/changelog
---
# Changelog
$(<Changelog.txt)
$(<History.md)
EOL

4 comments on commit e9f40a2

@mroderick
Copy link
Member

Choose a reason for hiding this comment

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

The History.md in root has not been updated with v4.0.1, something I discovered when I created v4.0.0, but forgot about again.

Why was this change made? What can we do to make sure that History.md is kept up to date, like Changelog.txt was?

@mroderick
Copy link
Member

Choose a reason for hiding this comment

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

Ping @fatso83 (not sure if you'd get a notification otherwise)

@fatso83
Copy link
Contributor Author

@fatso83 fatso83 commented on e9f40a2 Oct 5, 2017

Choose a reason for hiding this comment

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

@mroderick Sorry about that. I am not sure reason for doing the change was the best: it might have just be to bring the naming in line with lolex and the default naming scheme for the git-extras command, seeing that it actually produced Markdown.

We can revert this commit or just fix the omission:
make git add Changelog.txt be git add History.md

@mroderick
Copy link
Member

Choose a reason for hiding this comment

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

just fix the omission

👍

Please sign in to comment.