Skip to content

Commit

Permalink
Docs and changelog for version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
tomdyson committed Sep 29, 2020
1 parent fe6de2b commit dd8fa70
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 12 deletions.
16 changes: 8 additions & 8 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
...

## v0.5

## [Unreleased](https://github.com/tomdyson/wagtail-netlify/compare/v0.4...HEAD)
### Added

...
- A view for exposing redirects in Netlify's plain text format

## [v0.4](https://github.com/tomdyson/wagtail-netlify/compare/v0.3...v0.4)
## v0.4

### Added

- support for generating redirects without deploying

## [v0.3](https://github.com/tomdyson/wagtail-netlify/compare/v0.2...v0.3)
## v0.3

### Added

Expand All @@ -27,7 +27,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.

- Netlify-cli 1.x compatibility #13

## [v0.2](https://github.com/tomdyson/wagtail-netlify/compare/v0.1...v0.2)
## v0.2

### Added

Expand All @@ -38,6 +38,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Prevent modification of Deployment objects #2
- Prevent registration of Deployment modeladmin when the modeladmin app isn't installed #3

## [v0.1](https://github.com/tomdyson/wagtail-netlify/compare/f8f45701f43e28e238fc64aceea07dd1900343fc...v0.1)
## v0.1

Initial Release
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The function to be called when a deploy is triggered (excluding when triggered m

The function needs to be a valid [Django signal receiver](https://docs.djangoproject.com/en/2.1/topics/signals/#receiver-functions).

### Optional admin view
### Optional admin view and endpoints

Netlify can send a webhook after a successful deployment. This app provides an endpoint for that webhook and an admin view of completed deployments. To enable this view:

Expand All @@ -77,16 +77,18 @@ Netlify can send a webhook after a successful deployment. This app provides an e

```python
# in your imports
from wagtailnetlify import views as netlify_views
from wagtailnetlify import urls as netlify_urls

# in urlpatterns, before including wagtail_urls
url(r'^netlify/', netlify_views.success_hook, name='netlify'),
url(r"^netlify/", include(netlify_urls)),
```

3. In Netlify's admin interface for your app, add http://yourdomain/netlify/success as a URL to notify for the outgoing webhook on *Deploy succeeded* events (in Settings / Build & deploy / Deploy notifications).

The view will be available under `Settings / Deployments` in your site's admin.

Including the `wagtailnetlify` URLs will also enable a view at /netlify/redirects, which outputs any Wagtail redirects in [Netlify's plain text format](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file). This may be useful if you are using Netlify to host a headless front-end for your Wagtail site.

## Development

### Releases
Expand Down
2 changes: 1 addition & 1 deletion wagtailnetlify/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.4"
__version__ = "0.5"

0 comments on commit dd8fa70

Please sign in to comment.