Skip to content

Commit

Permalink
Merge pull request #41 from andstor/develop
Browse files Browse the repository at this point in the history
v1.2.1
  • Loading branch information
andstor authored Dec 7, 2021
2 parents 2fb2b53 + 7e700c5 commit 06eafcc
Show file tree
Hide file tree
Showing 620 changed files with 38,435 additions and 16,894 deletions.
17 changes: 17 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Enable dependabot, a tool to automatically propose dependency updates

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"

# Maintain dependencies for npm
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"
target-branch: "develop"
9 changes: 6 additions & 3 deletions .github/workflows/node_modules.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
name: Update node_modules

on:
workflow_dispatch:
push:
branches:
- 'develop'
Expand All @@ -10,13 +11,15 @@ on:
- '.github/workflows/node_modules.yml'

jobs:
prune:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Set up Node
uses: actions/setup-node@v1
uses: actions/setup-node@v2
with:
node-version: '14'
- name: Prune prod
run: |
rm -rf node_modules
Expand All @@ -31,7 +34,7 @@ jobs:
-
name: Commit and push changes
run: |
git add .
git add -A
if output=$(git status --porcelain) && [ ! -z "$output" ]; then
git commit -m 'Update node_modules'
git push
Expand Down
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
node_modules/

# Editors
.vscode

Expand Down
8 changes: 7 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ and this project adheres to [Semantic Versioning](https://semver.org).

## [Unreleased]


## [1.2.1] - 2021-12-07
### Fixed
- Support template installation with Node.js 16 ([#40](https://github.com/andstor/jsdoc-action/issues/40)).

## [1.2.0] - 2020-04-21
### Changed
- Deprecates the `template_name` input variable in favor of `template`.
Expand Down Expand Up @@ -36,7 +41,8 @@ and this project adheres to [Semantic Versioning](https://semver.org).

## 1.0.0 - 2020-02-22

[Unreleased]: https://github.com/andstor/jsdoc-action/compare/v1.2.0...HEAD
[Unreleased]: https://github.com/andstor/jsdoc-action/compare/v1.2.1...HEAD
[1.2.1]: https://github.com/andstor/jsdoc-action/compare/v1.2.0...v1.2.1
[1.2.0]: https://github.com/andstor/jsdoc-action/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/andstor/jsdoc-action/compare/v1.0.2...v1.1.0
[1.0.2]: https://github.com/andstor/jsdoc-action/compare/v1.0.1...v1.0.2
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

> A GitHub Action to build JSDoc documentation
This is a GitHub Action to build your JavaScript documentation with [JSDoc](https://github.com/jsdoc/jsdoc). This action can easily be combined with other deployment actions, in order to publish the generated documentation to for example [GitHub Pages](https://pages.github.com). JSDoc [templates](https://github.com/jsdoc/jsdoc#templates) are aslo supported.
This is a GitHub Action to build your JavaScript documentation with [JSDoc](https://github.com/jsdoc/jsdoc). This action can easily be combined with other deployment actions, in order to publish the generated documentation to for example [GitHub Pages](https://pages.github.com). JSDoc [templates](https://github.com/jsdoc/jsdoc#templates) are also supported.

The following example [workflow step](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow) will generate documentation for all source files in the `./src` directory and output the built files to the `./out` directory.

Expand All @@ -17,7 +17,7 @@ The following example [workflow step](https://help.github.com/en/actions/configu
## Supported platforms
The jsdoc-action is a JavaScript action and is supported on both Linux, MacOS and Windows.
The jsdoc-action is a JavaScript action and is supported on both Linux, MacOS and Windows. The action supports stable versions of Node.js 14 and later.
| OS (runs-on) | ubuntu-latest | macos-latest | windows-latest |
|---|:---:|:---:|:---:|
Expand Down Expand Up @@ -54,9 +54,9 @@ To use a JSDoc [configuration file](https://jsdoc.app/about-configuring-jsdoc.ht

### GitHub Pages 🚀

An example for deploying JSDoc generated documentationto GitHub Pages with [actions-gh-pages](https://github.com/marketplace/actions/github-pages-action#table-of-contents).
An example for deploying JSDoc generated documentation to GitHub Pages with [actions-gh-pages](https://github.com/marketplace/actions/github-pages-action#table-of-contents).

This jsdoc-action workflow configuration uses the [Minami](https://github.com/nijikokun/minami) JSDoc template and uses the root `README.md` file as frontpage.
This jsdoc-action workflow configuration uses the [Minami](https://github.com/nijikokun/minami) JSDoc template and uses the root `README.md` file as the front page.

```yml
name: GitHub pages
Expand Down
9 changes: 9 additions & 0 deletions node_modules/@actions/core/LICENSE.md

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

178 changes: 172 additions & 6 deletions node_modules/@actions/core/README.md

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

7 changes: 3 additions & 4 deletions node_modules/@actions/core/lib/command.d.ts

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

Loading

0 comments on commit 06eafcc

Please sign in to comment.