Skip to content

Commit

Permalink
feat: Initial Release
Browse files Browse the repository at this point in the history
  • Loading branch information
bugloper committed Jun 17, 2024
0 parents commit 7cbf7c1
Show file tree
Hide file tree
Showing 30 changed files with 954 additions and 0 deletions.
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* @bugloper
.github/ @bugloper @SELISEdigitalplatforms/DEVOPS-ADMIN-ALL-REPOS
CODEOWNERS @bugloper @SELISEdigitalplatforms/DEVOPS-ADMIN-ALL-REPOS
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/security_bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
---
name: "Security Bug Report"
about: Report a security vulnerability in the gotenberg gem
title: "[SECURITY] Title of the security issue"
labels: security
assignees: ''

---

## Description

Please provide a clear and detailed description of the security vulnerability.

## Steps to Reproduce

1. List the steps to reproduce the vulnerability.
2. Include any relevant code snippets, configuration files, or logs.
3. Specify any special setup required to reproduce the issue.

## Expected Behavior

Describe what you expected to happen.

## Actual Behavior

Describe what actually happened.

## Impact

Explain the potential impact of this vulnerability. Include details on who might be affected and how severe the impact could be.

## Versions Affected

List all versions of the gotenberg gem that are affected by this issue. Include the version of Ruby and any other relevant dependencies.

## Environment

- **gotenberg version**:
- **Ruby version**:
- **Operating System**:
- **Other relevant dependencies**:

## Additional Information

Provide any additional information that may help us understand the issue and how to fix it. Include links to related issues, stack traces, or other relevant resources.

## Disclosure

- [ ] I confirm that I have not disclosed this vulnerability publicly and will not do so until a fix has been released.
- [ ] I agree to follow the gotenberg disclosure policy.

## Contact Information

(Optional) If you would like to be contacted regarding this issue, please provide your preferred contact method.

11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:
- package-ecosystem: "bundler" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
36 changes: 36 additions & 0 deletions .github/workflows/release-please.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Release
on:
push:
branches:
- "main" # main only
jobs:
build:
runs-on: ubuntu-latest
permissions: write-all
steps:
- uses: googleapis/release-please-action@v4
id: release
# Checkout code if release was created
- uses: actions/checkout@v4
if: ${{ steps.release.outputs.release_created }}
# Setup ruby if a release was created
- uses: ruby/setup-ruby@v1
with:
# Not needed with a .ruby-version file
ruby-version: 3.2.2
# runs 'bundle install' and caches installed gems automatically
bundler-cache: true
if: ${{ steps.release.outputs.release_created }}

- name: Publish to GPR
if: ${{ steps.release.outputs.release_created }}
run: |
mkdir -p $HOME/.gem
touch $HOME/.gem/credentials
chmod 0600 $HOME/.gem/credentials
printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
gem build *.gemspec
gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
env:
GEM_HOST_API_KEY: "Bearer ${{secrets.NEW_GITHUB_TOKEN}}"
OWNER: ${{ github.repository_owner }}
32 changes: 32 additions & 0 deletions .github/workflows/ruby.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.
# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby

name: Ruby Setup

on:
push:
branches: ["main"]

permissions:
contents: read

jobs:
test:
runs-on: ubuntu-latest
strategy:
matrix:
ruby-version: ["3.0", "3.1", "3.2"]

steps:
- uses: actions/checkout@v4
- name: Set up Ruby 3
uses: ruby/setup-ruby@v1
with:
ruby-version: ${{ matrix.ruby-version }}
bundler-cache: true
- name: Run tests
run: bundle exec rspec
11 changes: 11 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
Gemfile.lock
# rspec failure tracking
.rspec_status
3 changes: 3 additions & 0 deletions .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
".": "1.0.0"
}
3 changes: 3 additions & 0 deletions .rspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
--format documentation
--color
--require spec_helper
50 changes: 50 additions & 0 deletions .rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# AllCops
AllCops:
NewCops: enable
SuggestExtensions: false
TargetRubyVersion: 3.0

# Style/FrozenStringLiteralComment
Style/FrozenStringLiteralComment:
Enabled: true
EnforcedStyle: always

# Layout/LineLength
Layout/LineLength:
Max: 120

# Naming/FileName
Naming/FileName:
Enabled: true
Exclude:
- 'spec/**/*'
- 'test/**/*'

# Layout/IndentationWidth
Layout/IndentationWidth:
Width: 2

# Style/StringLiterals
Style/StringLiterals:
EnforcedStyle: double_quotes

# Lint/UselessAssignment
Lint/UselessAssignment:
Enabled: true

# Metrics/AbcSize
Metrics/AbcSize:
Max: 100

# Metrics/BlockLength
Metrics/BlockLength:
Exclude:
- 'spec/**/*.rb'

# Metrics/MethodLength
Metrics/MethodLength:
Max: 100

# Naming/AccessorMethodName
Naming/AccessorMethodName:
Enabled: false
9 changes: 9 additions & 0 deletions AUTHORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
gotenberg maintained by SELISEdigitalplatforms Bhutan.

### Current Team

### Alumni

### Thanks

We thank the above contributors for their efforts! 🙏
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
## [Released]
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
28 changes: 28 additions & 0 deletions CONTRIBUTION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[![Version](https://img.shields.io/gem/v/gotenberg)](https://rubygems.org/gems/gotenberg)
[![License](https://img.shields.io/github/license/bugloper/gotenberg)](https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg)

## How to contribute to gotenberg

#### **Did you find a bug?**

* [Open a Github issue](https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg/issues/new)

* **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/SELISEdigitalplatforms/l3-ruby-gem-gotenberg/issues).


#### **Did you write a patch that fixes a bug?**

* Open a new GitHub pull request with the patch.

* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

#### **Do you intend to add a new feature or change an existing one?**

* Open a Github issue with detailed description


gotenberg is a simple gotenberg ruby client and currently it has minimal features and would appreciate your contribution.

Thanks! :heart: :heart: :heart:

SELISEdigitalplatforms
Loading

0 comments on commit 7cbf7c1

Please sign in to comment.