https://github.com/zejnilovic/enceladus-gh-pages

https://github.com/zejnilovic/enceladus-gh-pages

Last synced: about 7 hours ago
JSON representation

• Host: GitHub
• URL: https://github.com/zejnilovic/enceladus-gh-pages
• Owner: Zejnilovic
• Created: 2020-07-13T13:35:59.000Z (over 4 years ago)
• Default Branch: ghp/1439-add-width-to-schema-metadata
• Last Pushed: 2023-01-31T03:59:05.000Z (almost 2 years ago)
• Last Synced: 2023-02-28T23:31:39.757Z (over 1 year ago)
• Language: Ruby
• Size: 5.02 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Enceladus's Github Pages branch

This branch's sole purpose is to serve as Documentation for the Enceladus project.

### Dependencies:

- ruby >= 2.3.0

### To build locally:

```bash

# In the root of the project

$> git checkout gh-pages

$> bundle install

$> bundle exec jekyll serve

# => Now browse to http://localhost:4000

```

### Run convinience scripts

#### Generate new docs

```ruby

ruby utils/create_docs.rb 

```

#### Generate release notes

A Ruby script to generate release notes. 

```bash

Usage: ruby utils/get_release_notes.rb VERSION [options]

Specific options:

        --github-token TOKEN         Github token. Can be specified using environment variable GITHUB_TOKEN or in get_release_notes.json in resources using github_token key

        --zenhub-token TOKEN         Zenhub token. This means we will use Release object for release notes. You don't have to use --use-zenhub in case you do this. Can be specified using environment variable ZENHUB_TOKEN or in get_release_notes.json in resources using zenhub_token key

    -z, --use-zenhub                 Run using zenhub. It needs zenhub token set. If you use --zenhub-token option, you don't need to use this. This means we will use Release object for release notes.

        --organization ORGANIZATION  Github Organization

        --repository REPOSITORY      Github Repository name

        --repository-id REPOSITORYID Zenhub Repository ID

        --zenhub-url ZENURL          Zenhub API URL

        --github-url GITURL          Github API URL

    -p, --[no-]print-empty           Should Issue with no release notes comment be included in the output file

        --[no-]print-only-title      Should Issue with no release notes comment be preceeded with 'Couldn't find comment'

    -s, --[no-]strict                Treats warnings as errors

    -h, --help                       Show this message

```