Merge pull request #15 from octokit-cr/deployment-and-repo-updates

Deployment and repo updates

Author: watzon

.ameba.yml

@@ -0,0 +1,28 @@
+Lint/NotNil:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Documentation/DocumentationAdmonition:
+  Enabled: false
+
+Lint/RedundantStringCoercion:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Naming/AccessorMethodName:
+  Enabled: false
+
+Style/NegatedConditionsInUnless:
+  Enabled: false
+
+Naming/BlockParameterName:
+  Enabled: false
+
+Globs:
+  - "**/*.cr"
+  - "!lib"
+  - "!spec/acceptance/acceptance.cr"

.crystal-version

@@ -0,0 +1 @@
+1.12.1

.gitattributes

@@ -0,0 +1 @@
+*.cr text eol=lf

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @GrantBirki @watzon

.github/dependabot.yml

@@ -0,0 +1,13 @@
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+---
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+    schedule:
+      interval: monthly

.github/workflows/acceptance.yml

@@ -0,0 +1,34 @@
+name: acceptance
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  acceptance:
+    name: acceptance
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: fetch crystal version
+        id: crystal-version
+        run: echo "crystal=$(cat .crystal-version)"
+
+      - name: install crystal
+        uses: crystal-lang/[email protected]
+        with:
+          crystal: ${{ steps.crystal-version.outputs.crystal }}
+      
+      - name: bootstrap
+        run: script/bootstrap
+
+      - name: acceptance
+        run: script/acceptance

.github/workflows/lint.yml

@@ -0,0 +1,37 @@
+name: lint
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  lint:
+    name: lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: fetch crystal version
+        id: crystal-version
+        run: echo "crystal=$(cat .crystal-version)"
+
+      - name: install crystal
+        uses: crystal-lang/[email protected]
+        with:
+          crystal: ${{ steps.crystal-version.outputs.crystal }}
+
+      - name: bootstrap
+        run: script/bootstrap
+
+      - name: lint
+        run: script/lint
+
+      - name: format check
+        run: script/format --check

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+
+      - name: fetch crystal version
+        id: crystal-version
+        run: echo "crystal=$(cat .crystal-version)"
+
+      - name: install crystal
+        uses: crystal-lang/[email protected]
+        with:
+          crystal: ${{ steps.crystal-version.outputs.crystal }}
+
+      - name: test
+        run: script/test

.gitignore

@@ -1,9 +1,17 @@
-/lib/
-/bin/
-/.shards/
+# crystal
+.cache/shards/*
+tmp/
+bin/
+.shards/
 *.dwarf
+dist/
 
-# Libraries don't need dependency lock
-# Dependencies will be locked in applications that use them
-/shard.lock
-/.vscode/
+# non-critical vendored crystal files
+lib/**/.github/
+lib/**/docs/
+lib/**/examples/
+lib/**/spec/
+
+# secrets
+creds.env
+*.pem

.travis.yml

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 =====================
 
-Copyright © 2019 Chris Watson
+Copyright © 2019 Chris Watson + Grant Birkinbine + Contributors
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation
@@ -23,4 +23,3 @@ HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 OTHER DEALINGS IN THE SOFTWARE.
-

LICENSE

@@ -1,4 +1,6 @@
-# Octokit
+# octokit
+
+[![test](https://github.com/octokit-cr/octokit.cr/actions/workflows/test.yml/badge.svg)](https://github.com/octokit-cr/octokit.cr/actions/workflows/test.yml) [![lint](https://github.com/octokit-cr/octokit.cr/actions/workflows/lint.yml/badge.svg)](https://github.com/octokit-cr/octokit.cr/actions/workflows/lint.yml) [![acceptance](https://github.com/octokit-cr/octokit.cr/actions/workflows/acceptance.yml/badge.svg)](https://github.com/octokit-cr/octokit.cr/actions/workflows/acceptance.yml)
 
 Crystal toolkit for the GitHub API.
 
@@ -8,11 +10,11 @@ Crystal toolkit for the GitHub API.
 
 1. Add the dependency to your `shard.yml`:
 
-```yaml
-dependencies:
-  octokit:
-    github: watzon/octokit.cr
-```
+    ```yaml
+    dependencies:
+      octokit:
+        github: octokit-cr/octokit.cr
+    ```
 
 2. Run `shards install`
 
@@ -23,19 +25,19 @@ require "octokit"
 
 # Create a new Octokit Client
 # Your password should be your Personal Access Token (PAT)
-github = Octokit.client("watzon", "PASSWORD")
+github = Octokit.client("grantbirki", "PASSWORD")
 
 # Also, you can authenticate this way:
-# github = Octokit.client("watzon", access_token: "PAT")
+# github = Octokit.client("grantbirki", access_token: "PAT")
 
 # Fetch information about the logged in user
 pp github.user
 
 # Fetch information about another user
-pp github.user("asterite")
+pp github.user("watzon")
 ```
 
-There are way too many options to list here, even at this early stage. For more usage examples see the [documentation](https://watzon.github.io/octokit.cr/).
+There are way too many options to list here, even at this early stage. For more usage examples see the [documentation](https://octokit-cr.github.io/octokit.cr/).
 
 ## Roadmap
 
@@ -48,19 +50,19 @@ There are a lot of pieces of the GitHub API to cover. Here are the ones that nee
 - [ ] [Commits]()
 - [ ] [CommunityProfile]()
 - [ ] [Contents]()
-- [ ] [Deployments]()
+- [x] [Deployments](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Deployments.html)
 - [ ] [Downloads]()
 - [ ] [Emojis]()
 - [ ] [Events]()
 - [ ] [Feeds]()
 - [ ] [Gists]()
 - [ ] [Gitignore]()
 - [ ] [Hooks]()
-- [x] [Issues](https://watzon.github.io/octokit.cr/Octokit/Client/RateLimit.html)
+- [x] [Issues](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Issues.html)
 - [ ] [Labels]()
 - [ ] [LegacySearch]()
 - [ ] [Licenses]()
-- [x] [Markdown](https://watzon.github.io/octokit.cr/Octokit/Client/Markdown.html)
+- [x] [Markdown](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Markdown.html)
 - [ ] [Marketplace]()
 - [ ] [Meta]()
 - [ ] [Milestones]()
@@ -69,40 +71,41 @@ There are a lot of pieces of the GitHub API to cover. Here are the ones that nee
 - [ ] [Organizations]()
 - [ ] [Pages]()
 - [ ] [Projects]()
-- [x] [PubSubHubbub](https://watzon.github.io/octokit.cr/Octokit/Client/PubSubHubbub.html)
+- [x] [PubSubHubbub](https://octokit-cr.github.io/octokit.cr/Octokit/Client/PubSubHubbub.html)
 - [ ] [PullRequests]()
-- [x] [RateLimit](https://watzon.github.io/octokit.cr/Octokit/Client/RateLimit.html)
+- [x] [RateLimit](https://octokit-cr.github.io/octokit.cr/Octokit/Client/RateLimit.html)
 - [ ] [Reactions]()
 - [ ] [Refs]()
-- [x] [Releases](https://watzon.github.io/octokit.cr/Octokit/Client/Releases.html)
-- [x] [Repositories](https://watzon.github.io/octokit.cr/Octokit/Client/Repositories.html)
+- [x] [Releases](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Releases.html)
+- [x] [Repositories](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Repositories.html)
 - [ ] [RepositoryInvitations]()
 - [ ] [Reviews]()
-- [x] [Say](https://watzon.github.io/octokit.cr/Octokit/Client/Say.html)
-- [x] [Search](https://watzon.github.io/octokit.cr/Octokit/Client/Search.html)
+- [x] [Say](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Say.html)
+- [x] [Search](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Search.html)
 - [ ] [ServiceStatus]()
 - [ ] [SourceImport]()
 - [ ] [Stats]()
-- [x] [Statuses](https://watzon.github.io/octokit.cr/Octokit/Client/Statuses.html)
+- [x] [Statuses](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Statuses.html)
 - [ ] [Traffic]()
-- [x] [Users](https://watzon.github.io/octokit.cr/Octokit/Client/Users.html)
+- [x] [Users](https://octokit-cr.github.io/octokit.cr/Octokit/Client/Users.html)
 
 I am trying to complete what I deem the most important ones first so that this shard can be immediately useful. Keep in mind, however, that the API may change at any time.
 
 ## Contributing
 
 I don't only welcome contributions, I beg for them. If this is a library that might help you out please, help me by forking this repo and porting one of the many APIs that's not checked above. Thank you!
 
-1. Fork it (<https://github.com/watzon/octokit/fork>)
+1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
 ## Contributors
 
-- [Chris Watson](https://github.com/watzon) - creator and maintainer
+- [Grant Birkinbine](https://github.com/GrantBirki)
+- [Chris Watson](https://github.com/watzon) - original creator and maintainer
 
-# Thanks
+## Thanks
 
 Thanks to all of the maintainers of [octokit/octokit.rb](https://github.com/octokit/octokit.rb) who made this so much easier on me. This library is a port of the ruby library and I've tried to keep the APIs as similar as possible.