Merge pull request #88 from yknx4/chore/rename-to-librecov

chore: rename to librecov

Author: yknx4

.github/workflows/ghcr.yml

@@ -2,7 +2,7 @@ name: CI to GHCR
 
 on:
   push:
-    branches: [ master ]
+    branches: [ main ]
 
 env:
   REGISTRY: ghcr.io

.github/workflows/release-drafter.yml

@@ -19,7 +19,7 @@ jobs:
       #  run: |
       #    echo "GHE_HOST=${GITHUB_SERVER_URL##https:\/\/}" >> $GITHUB_ENV
 
-      # Drafts your next Release notes as Pull Requests are merged into "master"
+      # Drafts your next Release notes as Pull Requests are merged into "main"
       - uses: release-drafter/release-drafter@v5
         # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
         # with:

.github/workflows/tests.yml

@@ -117,7 +117,7 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
           files: cover/excoveralls.json
           fail_ci_if_error: true
-      - name: OpenCov
+      - name: LibreCov
         continue-on-error: true
         env:
           SHA: ${{github.sha}}

.travis.yml

@@ -44,8 +44,8 @@ WORKDIR /app
 
 # USER nobody:nobody
 
-COPY --from=build --chown=nobody:nobody /app/_build/prod/rel/opencov ./
+COPY --from=build --chown=nobody:nobody /app/_build/prod/rel/librecov ./
 
 ENV HOME=/app
 
-CMD ["bin/opencov", "start"]
+CMD ["bin/librecov", "start"]

Dockerfile

@@ -1,18 +1,18 @@
-# OpenCov
+# LibreCov
 
-![Build Status](https://github.com/yknx4/opencov/actions/workflows/tests.yml/badge.svg)
-[![Coverage Status](https://opencov-reloaded.herokuapp.com/projects/1/badge.svg)](https://opencov-reloaded.herokuapp.com/projects/1)
-[![codecov](https://codecov.io/gh/yknx4/opencov/branch/main/graph/badge.svg?token=Q9kaFXoFTn)](https://codecov.io/gh/yknx4/opencov)
+![Build Status](https://github.com/yknx4/librecov/actions/workflows/tests.yml/badge.svg)
+[![Coverage Status](https://www.librecov.com/projects/1/badge.svg)](https://www.librecov.com/projects/1)
+[![codecov](https://codecov.io/gh/yknx4/librecov/branch/main/graph/badge.svg?token=Q9kaFXoFTn)](https://codecov.io/gh/yknx4/librecov)
 
-OpenCov is a self-hosted opensource test coverage history viewer.
+LibreCov is a self-hosted opensource test coverage history viewer.
 It is (mostly) compatible with [coveralls](https://coveralls.io/), so most
 coverage tools will work easily.
 
 ## Demo and screenshots
 
-A demo is available at https://opencov-reloaded.herokuapp.com, you can create an account or login with
+A demo is available at https://www.librecov.com, you can create an account or login with
 
-* username: user@opencov.com
+* username: user@librecov.com
 * password: password123
 
 For "security" reasons, the user is not admin.
@@ -44,7 +44,7 @@ NOTE: the demo is on a Heroku free dyno, so it may not always be available and m
 
 First, you will need to at least setup a database
 To configure the app, create a `local.exs` file and override the configuration you need.
-Check [config/local.sample.exs](https://github.com/yknx4/opencov/blob/master/config/local.sample.exs) to see the available configurations.
+Check [config/local.sample.exs](https://github.com/yknx4/librecov/blob/main/config/local.sample.exs) to see the available configurations.
 
 ### Using docker
 
@@ -54,32 +54,32 @@ If you already have a database to use, you can simply start the application usin
 
 Setup database, run migrations and seeds
 ```
-$ docker run --rm -v /absolute/path/to/local.exs:/opencov/config/local.exs yknx4/opencov mix ecto.setup
+$ docker run --rm -v /absolute/path/to/local.exs:/librecov/config/local.exs yknx4/librecov mix ecto.setup
 ```
 
 Execute Phoenix Server
 ```
-$ docker run -v /absolute/path/to/local.exs:/opencov/config/local.exs yknx4/opencov
+$ docker run -v /absolute/path/to/local.exs:/librecov/config/local.exs yknx4/librecov
 ```
 
 This will start the server on the port you set in `local.exs`.
 
 #### With docker-compose
 
-If you do not have a database, you can start one with `docker` and `docker-compose`. See [docker-compose.yml](https://github.com/yknx4/opencov/blob/master/docker-compose.yml) for a sample `docker-compose.yml` file.
+If you do not have a database, you can start one with `docker` and `docker-compose`. See [docker-compose.yml](https://github.com/yknx4/librecov/blob/main/docker-compose.yml) for a sample `docker-compose.yml` file.
 
 Once you have your `docker-compose.yml` and `local.exs` ready, you can run
 
 ```
-$ docker-compose run opencov mix ecto.setup
+$ docker-compose run librecov mix ecto.setup
 $ docker-compose up
 ```
 
 ### Manually
 
 ```
-$ git clone https://github.com/yknx4/opencov.git
-$ cd opencov
+$ git clone https://github.com/yknx4/librecov.git
+$ cd librecov
 $ cp /path/to/local.exs config/local.exs # local.exs must be in the `config` directory of the app
 
 $ npm install # (or yarn install)
@@ -88,7 +88,7 @@ $ mix ecto.setup
 $ mix phoenix.server
 ```
 
-This should start OpenCov at port 4000.
+This should start LibreCov at port 4000.
 
 If you want to setup the server for production, you will need to run the above commands
 with `MIX_ENV=prod` and to run
@@ -104,8 +104,8 @@ before starting the server.
 You should also be able to deploy to Heroku by simply git pushing this repository.
 You will need to set the following environment variables using `heroku config:set`
 
-* `OPENCOV_PORT`
-* `OPENCOV_SCHEME`
+* `LIBRECOV_PORT`
+* `LIBRECOV_SCHEME`
 * `SECRET_KEY_BASE`
 * `SMTP_USER`
 * `SMTP_PASSWORD`
@@ -129,9 +129,9 @@ You should use it for your first login and the change the email and password.
 
 ## Sending test metrics
 
-A few languages are documented in [the wiki](https://github.com/yknx4/opencov/wiki).
+A few languages are documented in [the wiki](https://github.com/yknx4/librecov/wiki).
 For other languages, coveralls instructions should work out of the box,
-you just need to set the URL to your OpenCov server and to explicitly set
+you just need to set the URL to your LibreCov server and to explicitly set
 the token, even when using Travis.
 
 ## Development status
@@ -140,6 +140,6 @@ The application is more or less stable. I have been using it
 for a little while now with coverage data from the 4 languages in the Wiki.
 
 The main missing feature is the ability to send coverage status on pull requests.
-The implementation is started in the [integrations branch](https://github.com/yknx4/opencov/tree/integrations) but I could not find the time to finish it yet.
+The implementation is started in the [integrations branch](https://github.com/yknx4/librecov/tree/integrations) but I could not find the time to finish it yet.
 
 I am open to any other suggestions, and help is very welcome.

README.md

@@ -1,18 +1,18 @@
 use Mix.Config
 
-config :opencov, Opencov.Endpoint,
+config :librecov, Librecov.Endpoint,
   url: [host: "localhost"],
   root: Path.dirname(__DIR__),
   secret_key_base: "tfYGCfFfu10pV8G5gtUJ1do3LDwnu+eWBfL1sNtK8+bEwo6gNzFQZtWkdNQVlt+V",
   render_errors: [accepts: ~w(html json)],
-  pubsub_server: Opencov.PubSub
+  pubsub_server: Librecov.PubSub
 
-config :opencov,
+config :librecov,
   badge_format: "svg",
   base_url: "http://localhost:4000",
-  ecto_repos: [Opencov.Repo]
+  ecto_repos: [Librecov.Repo]
 
-config :opencov, :github, client_id: System.get_env("OPENCOV_GITHUB_CLIENT_ID")
+config :librecov, :github, client_id: System.get_env("LIBRECOV_GITHUB_CLIENT_ID")
 
 config :logger, :console,
   format: "$time $metadata[$level] $message\n",
@@ -25,33 +25,33 @@ config :phoenix, :generators,
 config :phoenix, :json_library, Jason
 
 config :scrivener_html,
-  routes_helper: Opencov.Router.Helpers
+  routes_helper: Librecov.Router.Helpers
 
-config :opencov, PlugBasicAuth, enable: false
+config :librecov, PlugBasicAuth, enable: false
 
-config :seedex, repo: Opencov.Repo
+config :seedex, repo: Librecov.Repo
 
-config :opencov, :email,
-  sender: "OpenCov <info@opencov.com>",
+config :librecov, :email,
+  sender: "LibreCov <info@librecov.com>",
   smtp: [
     relay: "smtp.mailgun.org",
-    username: System.get_env("SMTP_USER") || "info@opencov.com",
+    username: System.get_env("SMTP_USER") || "info@librecov.com",
     password: System.get_env("SMTP_PASSWORD") || "I wouldn't share this",
     port: 587,
     ssl: false,
     tls: :always,
     auth: :always
   ]
 
-config :opencov, :demo,
-  enabled: System.get_env("OPENCOV_DEMO") == "true",
-  email: "user@opencov.com",
+config :librecov, :demo,
+  enabled: System.get_env("LIBRECOV_DEMO") == "true",
+  email: "user@librecov.com",
   password: "password123"
 
 config :joken,
   rs256: [
     signer_alg: "RS256",
-    key_pem: System.get_env("OPENCOV_GITHUB_SECRET_KEY")
+    key_pem: System.get_env("LIBRECOV_GITHUB_SECRET_KEY")
   ]
 
 import_config "#{Mix.env()}.exs"

config/config.exs

@@ -6,7 +6,7 @@ use Mix.Config
 # The watchers configuration can be used to run external
 # watchers to your application. For example, we use it
 # with brunch.io to recompile .js and .css sources.
-config :opencov, Opencov.Endpoint,
+config :librecov, Librecov.Endpoint,
   http: [port: System.get_env("PORT") || 4000],
   debug_errors: true,
   code_reloader: true,
@@ -23,7 +23,7 @@ config :opencov, Opencov.Endpoint,
   ]
 
 # Watch static and templates for browser reloading.
-config :opencov, Opencov.Endpoint,
+config :librecov, Librecov.Endpoint,
   live_reload: [
     patterns: [
       ~r{priv/static/.*(js|css|png|jpeg|jpg|gif|svg)$},
@@ -42,16 +42,16 @@ config :logger, :console, format: "[$level] $message\n"
 config :phoenix, :stacktrace_depth, 20
 
 # Configure your database
-config :opencov, Opencov.Repo,
+config :librecov, Librecov.Repo,
   adapter: Ecto.Adapters.Postgres,
   username: "postgres",
   password: "postgres",
-  database: "opencov_dev",
+  database: "librecov_dev",
   hostname: "localhost",
   pool_size: 10
 
-config :opencov, :email,
-  sender: "OpenCov <info@opencov.com>",
+config :librecov, :email,
+  sender: "LibreCov <info@librecov.com>",
   smtp: [
     relay: "127.0.0.1",
     port: 1025,
@@ -60,7 +60,7 @@ config :opencov, :email,
     auth: :never
   ]
 
-config Opencov.Plug.Github,
+config Librecov.Plug.Github,
   secret: "my-secret",
   path: "/api/v1/github_webhook",
-  action: {Opencov.GithubService, :handle}
+  action: {Librecov.GithubService, :handle}

config/dev.exs

@@ -1,17 +1,17 @@
 use Mix.Config
 
-config :opencov, Opencov.Endpoint,
+config :librecov, Librecov.Endpoint,
   http: [port: 4000],
-  url: [scheme: "http", host: "demo.opencov.com", port: 80],
+  url: [scheme: "http", host: "demo.librecov.com", port: 80],
   secret_key_base: "my-super-secret-key-base-with-64-characters-so-that-i-dont-get-an-error"
 
-config :opencov, Opencov.Repo,
+config :librecov, Librecov.Repo,
   adapter: Ecto.Adapters.Postgres,
-  url: "postgres://postgres:112233@postgres/opencov_prod",
+  url: "postgres://postgres:112233@postgres/librecov_prod",
   pool_size: 20
 
-config :opencov, :email,
-  sender: "OpenCov <info@example.com>",
+config :librecov, :email,
+  sender: "LibreCov <info@example.com>",
   smtp: [
     relay: "smtp.example.com",
     username: "info@example.com",

config/local.sample.exs

@@ -1,32 +1,32 @@
 use Mix.Config
 
-config :opencov, Opencov.Endpoint,
+config :librecov, Librecov.Endpoint,
   http: [port: {:system, "PORT"}],
   url: [
-    scheme: System.get_env("OPENCOV_SCHEME") || "https",
-    host: System.get_env("OPENCOV_HOST") || "demo.opencov.com",
-    port: System.get_env("OPENCOV_PORT") || 443
+    scheme: System.get_env("LIBRECOV_SCHEME") || "https",
+    host: System.get_env("LIBRECOV_HOST") || "demo.librecov.com",
+    port: System.get_env("LIBRECOV_PORT") || 443
   ],
   secret_key_base: System.get_env("SECRET_KEY_BASE")
 
-config :opencov, Opencov.Repo,
+config :librecov, Librecov.Repo,
   adapter: Ecto.Adapters.Postgres,
   url: System.get_env("DATABASE_URL"),
   ssl: true,
   pool_size: String.to_integer(System.get_env("POSTGRES_POOL_SIZE") || "10")
 
-config :opencov, :auth,
-  enable: System.get_env("OPENCOV_AUTH") == "true",
-  username: System.get_env("OPENCOV_USER"),
-  password: System.get_env("OPENCOV_PASSWORD"),
-  realm: System.get_env("OPENCOV_REALM") || "Protected OpenCov"
+config :librecov, :auth,
+  enable: System.get_env("LIBRECOV_AUTH") == "true",
+  username: System.get_env("LIBRECOV_USER"),
+  password: System.get_env("LIBRECOV_PASSWORD"),
+  realm: System.get_env("LIBRECOV_REALM") || "Protected LibreCov"
 
 config :logger, level: :info
 
-config Opencov.Plug.Github,
-  secret: System.get_env("OPENCOV_GITHUB_WEBOOK_SECRET") || "super-secret",
+config Librecov.Plug.Github,
+  secret: System.get_env("LIBRECOV_GITHUB_WEBOOK_SECRET") || "super-secret",
   path: "/api/v1/github_webhook",
-  action: {Opencov.GithubService, :handle}
+  action: {Librecov.GithubService, :handle}
 
 if File.exists?(Path.join(__DIR__, "prod.secret.exs")) do
   import_config "prod.secret.exs"