Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/grrr-amsterdam/nova-publish
Add a publish button to trigger a Github Action workflow
https://github.com/grrr-amsterdam/nova-publish
github-actions-workflow hacktoberfest-accepted laravel nova static-site
Last synced: 4 days ago
JSON representation
Add a publish button to trigger a Github Action workflow
- Host: GitHub
- URL: https://github.com/grrr-amsterdam/nova-publish
- Owner: grrr-amsterdam
- Created: 2021-02-15T14:03:20.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-02T12:36:51.000Z (27 days ago)
- Last Synced: 2024-12-02T13:22:33.289Z (27 days ago)
- Topics: github-actions-workflow, hacktoberfest-accepted, laravel, nova, static-site
- Language: PHP
- Homepage:
- Size: 304 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: .github/readme-hero.png
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Nova publish
[](https://github.com/grrr-amsterdam/nova-publish/actions/workflows/run-tests.yaml) [](https://github.com/grrr-amsterdam/nova-publish/actions/workflows/code-style.yaml)
> Adds a publish button to Nova to trigger a GitHub workflow which runs you static site generator
### Developed with ❤️ by [GRRR](https://grrr.nl)
- GRRR is a [B Corp](https://grrr.nl/en/b-corp/)
- GRRR has a [tech blog](https://grrr.tech/)
- GRRR is [hiring](https://grrr.nl/en/jobs/)
- [@GRRRTech](https://twitter.com/grrrtech) tweets
## Requirements
[Return To Top](#nova-publish)
- PHP 7.4
- GitHub Actions workflow
## Installation
[Return To Top](#nova-publish)
Add the repository to `composer.json`
```JSON
"repositories": [
{
"type": "vcs",
"url": "https://github.com/grrr-amsterdam/nova-publish"
}
]
```
Add install the package
```shell script
composer require grrr-amsterdam/nova-publish
```
Load the tool by adding it to `NovaServiceProvider.php`
```php
use Publish\Publish;
public function tools()
{
return [new Publish()];
}
```
Publish configuration
```shell
php artisan vendor:publish --provider="Publish\ToolServiceProvider"
```
Configure GitHub credentials, set the path to the workflow file and configure an application version.
## GitHub API credentials
Personal Access Tokens (PATs) are currently the only way to access the GitHub API. The token is created by a GitHub user. So when this user is removed from the GitHub organization the token must be recreated by another user. Not ideal, so there is room for improvement.
Create a Personal Access Token: https://github.com/settings/tokens
- Note: the name of the project
- Expiration: No expiration (or you have to replace the token every time it expires)
- Scopes: "repo" and "workflow"
Add the created token as environment variable `PUBLISH_GITHUB_PERSONAL_ACCESS_TOKEN`.
You GitHub username must be stored in `PUBLISH_GITHUB_USERNAME`.
## Contribute
You need a Nova license to run the tests.