Skip to content
This repository has been archived by the owner on Feb 29, 2024. It is now read-only.

Commit

Permalink
Update project files (#104)
Browse files Browse the repository at this point in the history
* Remove references to CodeClimate

* Remove Code of Conduct and Contributing files

* Simplify EditorConfig

* Update Git ignore file

* Remove reek

* Remove Bundler ecosystem, add GitHub Actions

* Refactor CI workflow
  • Loading branch information
jgarber623 authored Dec 13, 2023
1 parent 07f053b commit 90e84de
Show file tree
Hide file tree
Showing 10 changed files with 22 additions and 175 deletions.
5 changes: 0 additions & 5 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# EditorConfig is awesome: http://EditorConfig.org
root = true

[*]
Expand All @@ -9,9 +8,5 @@ indent_size = 2
indent_style = space
trim_trailing_whitespace = true

[*.md]
indent_size = 4
indent_style = tab

[*.svg]
insert_final_newline = false
3 changes: 2 additions & 1 deletion .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
version: 2

updates:
- package-ecosystem: "bundler"
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
Expand Down
23 changes: 13 additions & 10 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,34 +1,37 @@
name: CI

on: [push, pull_request]
on:
pull_request:
push:
branches: [main]
schedule:
- cron: "0 12 * * 3"
workflow_call:
workflow_dispatch:

jobs:
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
- run: bundle exec rubocop
- run: bundle exec reek
test:
name: Test
runs-on: ubuntu-latest
needs: lint
strategy:
fail-fast: false
matrix:
# See: https://github.com/actions/runner/issues/849
ruby: [2.5, 2.6, 2.7, "3.0", 3.1]
os: [macos-latest, ubuntu-latest]
ruby: ["3.0", "3.1", "3.2", "3.3"]
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
- uses: ruby/setup-ruby@v1
with:
bundler-cache: true
ruby-version: ${{ matrix.ruby }}
- run: npm install -g svgo@1.3.2
- run: bundle exec rspec
- uses: paambaati/codeclimate-action@v3.2.0
env:
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
8 changes: 6 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,10 @@
# Used by dotenv library to load environment variables.
# .env

# Ignore history files.
.irb_history
.rdbg_history

# Documentation cache and generated files:
/.yardoc/
/_yardoc/
Expand All @@ -33,5 +37,5 @@ Gemfile.lock
# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
.rvmrc

# Ignore cached RuboCop configuration files
/.rubocop-*
# Used by RuboCop. Remote config files pulled in from inherit_from directive.
.rubocop-https?--*
20 changes: 0 additions & 20 deletions .reek.yml

This file was deleted.

76 changes: 0 additions & 76 deletions CODE_OF_CONDUCT.md

This file was deleted.

46 changes: 0 additions & 46 deletions CONTRIBUTING.md

This file was deleted.

1 change: 0 additions & 1 deletion Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ gemspec

gem 'pry-byebug'
gem 'rake'
gem 'reek'
gem 'rspec'
gem 'rubocop'
gem 'rubocop-packaging'
Expand Down
13 changes: 0 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@
[![Gem](https://img.shields.io/gem/v/svgeez.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/svgeez)
[![Downloads](https://img.shields.io/gem/dt/svgeez.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/svgeez)
[![Build](https://img.shields.io/github/actions/workflow/status/jgarber623/svgeez/ci.yml?branch=main&logo=github&style=for-the-badge)](https://github.com/jgarber623/svgeez/actions/workflows/ci.yml)
[![Maintainability](https://img.shields.io/codeclimate/maintainability/jgarber623/svgeez.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/svgeez)
[![Coverage](https://img.shields.io/codeclimate/c/jgarber623/svgeez.svg?logo=code-climate&style=for-the-badge)](https://codeclimate.com/github/jgarber623/svgeez/code)

If you're using an [SVG](https://en.wikipedia.org/wiki/Scalable_Vector_Graphics) icon system in your Web projects, svgeez can help speed up your workflow by automating the SVG sprite generation process. Run svgeez alongside your existing project (or integrate it into your current build system); add, edit, or delete SVG files from a folder; and marvel as svgeez generates a single SVG sprite file ready for inclusion in your user interface.

Expand Down Expand Up @@ -197,17 +195,6 @@ button svg {
}
```

## Improving svgeez

You want to help make svgeez better? Hell yeah! I like your enthusiasm. For more on how you can help, check out [CONTRIBUTING.md](https://github.com/jgarber623/svgeez/blob/main/CONTRIBUTING.md).

### Donations

If diving into Ruby isn't your thing, but you'd still like to support svgeez, consider making a donation! Any amount—large or small—is greatly appreciated. As a token of my gratitude, I'll add your name to the [Acknowledgments](#acknowledgments) below.

[![Donate via Square Cash](https://img.shields.io/badge/square%20cash-$jgarber-28c101.svg?style=for-the-badge)](https://cash.me/$jgarber)
[![Donate via Paypal](https://img.shields.io/badge/paypal-jgarber-009cde.svg?style=for-the-badge)](https://www.paypal.me/jgarber)

## Acknowledgments

svgeez benefited greatly from the hard work done by the folks working on the following projects:
Expand Down
2 changes: 1 addition & 1 deletion svgeez.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Gem::Specification.new do |spec|
spec.license = 'MIT'

spec.files = Dir['exe/**/*', 'lib/**/*'].reject { |f| File.directory?(f) }
spec.files += %w[LICENSE CHANGELOG.md CODE_OF_CONDUCT.md CONTRIBUTING.md README.md]
spec.files += %w[LICENSE CHANGELOG.md README.md]
spec.files += %w[svgeez.gemspec]

spec.bindir = 'exe'
Expand Down

0 comments on commit 90e84de

Please sign in to comment.