Giter Club home page Giter Club logo

verkilo's Introduction

Verkilo

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/verkilo. To experiment with that code, run bin/console for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

Installation

Add this line to your application's Gemfile:

gem 'verkilo'

And then execute:

$ bundle

Or install it yourself as:

$ gem install verkilo

Usage

TODO: Write usage instructions here

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Use gem-release Gem

$ gem bump --version minor # bumps to the next minor version
$ gem bump --version major # bumps to the next major version
$ gem bump --version 1.1.1 # bumps to the specified version

https://bundler.io/guides/creating_gem.html

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/verkilo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Verkilo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

verkilo's People

Contributors

merovex avatar

Watchers

avatar avatar

verkilo's Issues

Need Checksum && default in imprint logo

Ran into a problem where the missing imprint logo broke the build. Preferred action is use of a safe default and a warning

  • Add annotations to the build...with option
  • Add a default in the gem that is used if imprint logo is missing

Convert Word Doc back to Markdown

GH Prep

  • Create landing zone directory
  • Create landing zone branch
  • Create processed directory
  • Create GH Action for when push from LZ Branch

Docker

  • Convert Word to Markdown
  • Split Markdown to Chapter Directories / Section Files

GH Execution

  • Convert to Markdown with Docker
  • Move Word to process directory
  • Commit LZ Branch

Documentation

  • Document GH Action
  • Manual steps

Annotate filename in compiled files

When authors send the document off for editing, they typically do so in MS Word format. However, when they receive the document back, they need to split it back into the original files.

  • Put a file indicator in the Source document
  • Hide the indicators in Word, PDF, epub, HTML

Build fails if there is no wordcount yaml file. 

Run docker://merovex/book-compiler:latest
/usr/bin/docker run --name merovexbookcompilerlatest_4716c8 --label 87c201 --workdir /github/workspace --rm -e GITHUB_TOKEN -e HOME -e GITHUB_JOB -e GITHUB_REF -e GITHUB_SHA -e GITHUB_REPOSITORY -e GITHUB_REPOSITORY_OWNER -e GITHUB_RUN_ID -e GITHUB_RUN_NUMBER -e GITHUB_ACTOR -e GITHUB_WORKFLOW -e GITHUB_HEAD_REF -e GITHUB_BASE_REF -e GITHUB_EVENT_NAME -e GITHUB_SERVER_URL -e GITHUB_API_URL -e GITHUB_GRAPHQL_URL -e GITHUB_WORKSPACE -e GITHUB_ACTION -e GITHUB_EVENT_PATH -e RUNNER_OS -e RUNNER_TOOL_CACHE -e RUNNER_TEMP -e RUNNER_WORKSPACE -e ACTIONS_RUNTIME_URL -e ACTIONS_RUNTIME_TOKEN -e ACTIONS_CACHE_URL -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/stranded-series/stranded-series":"/github/workspace" merovex/book-compiler:latest
/var/lib/gems/2.5.0/gems/verkilo-0.1.0/lib/verkilo/log.rb:12:in `data=': undefined method `merge' for nil:NilClass (NoMethodError)
	from /var/lib/gems/2.5.0/gems/verkilo-0.1.0/lib/verkilo/cli.rb:35:in `wordcount'
	from /var/lib/gems/2.5.0/gems/thor-0.20.3/lib/thor/command.rb:27:in `run'
	from /var/lib/gems/2.5.0/gems/thor-0.20.3/lib/thor/invocation.rb:126:in `invoke_command'
	from /var/lib/gems/2.5.0/gems/thor-0.20.3/lib/thor.rb:387:in `dispatch'
	from /var/lib/gems/2.5.0/gems/thor-0.20.3/lib/thor/base.rb:466:in `start'
	from /var/lib/gems/2.5.0/gems/verkilo-0.1.0/bin/verkilo:5:in `<top (required)>'
	from /usr/local/bin/verkilo:23:in `load'
	from /usr/local/bin/verkilo:23:in `<main>'
	from /usr/local/bin/ruby_executable_hooks2.5:24:in `eval'
	from /usr/local/bin/ruby_executable_hooks2.5:24:in `<main>'

GHA Compile Docker on commit

Would like to have the Docker built on push to master or pull_request to master.

  • Create Docker builder GH Action
  • Add to Wordcount Docker
  • Add to Compile docker
  • Add to Word Split Docker

Rescue Time Tracker

Integrate Rescue Time into Verkilo tracking so we can calculate total time writing and words-per-hour.

Problem is if there are multiple series...may not be viable.

GH Action

  • Create Cron Action, cloning the Wordcounter...
  • Run Docker...multiple repositories?
  • Commit change to Develop
  • Do I need a separate repository to track this?

Docker

  • Create Docker Repo
  • Get date range from processing the wordcount.yml file
  • Pull times in date range
  • Populate rescuetime.yml file

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.