Initial release including curated git history from the original repository #2

jcwilk · 2022-02-05T00:14:02Z

Original PR was here - #1

This branch is an attempt to maintain the history. Will add more details when the history aspect has been accepted.

Previously, Simplekiq did not provide a way to interact with the underlying batch object.

There was concern about exposing the sidekiq batch directly and making a habit of it, so we move it to a private object. Still accessible if you need it through `send` in say a REPL situation, but otherwise not usable.

The Simplekiq Batching Job API now supports everything this job needed. We can have the ProcessAllJob now take advantage of this so the batch can be defined in a single class.

Still needs some polish around the edges, but this is at least functional

Stolen from https://github.com/doximity/shoulda-matchers-uuid/blob/5da06b2068633516e3776966e39a544f864d795f/.circleci/config.yml with minor adjustments (mainly skipping anything related to mysql)

jcwilk · 2022-03-24T19:44:41Z

@jmonteiro and @jmvbxx - Tagging for a review on this new gem. Jason and I had a meeting and some discussion about this and I think it's all in-line as planned, biggest item of uncertainty would be the circle ci config which I borrowed from https://github.com/doximity/shoulda-matchers-uuid/blob/master/.circleci/config.yml#L114-L121 and stripped out the mysql-related stuff since there's no databases relevant to this gem.

Also planning to amend the wiki with the following information if y'all agree:

General requirements for open source releases:
* Use the Apache v2 license
* Keep project names and code, including comments, business appropriate
* External (non-Doximity employees) contributors must sign the Contributor License Agreement
* Ensure that both the LICENSE and the CLA requirements are explained and linked in the project README file
* Use semver (https://semver.org/) for the gem by default, consider starting it at 0.0.1 for the initial release to indicate things are still getting stabilized

Process for releasing a new gem under Doximity:
* Open a pull-request in terraform to add the new repository under the Github Doximity org account, start it as private.
* After the terraform PR gets merged the new, private repository will exist. Open a PR there for your code.
* Add all the code to the PR which is required to make it a complete gem repository including all of the above specified requirements.
* Also add circle ci config to make it able to build and publish the gem on merge to master, see https://github.com/doximity/shoulda-matchers-uuid/blob/5da06b2068633516e3776966e39a544f864d795f/.circleci/config.yml#L114-L121 for an example
* For reviewers, tag at least two reviewers, including someone at doximity who has worked with our open source gems in the past
* Once released, switch whichever app was using it to point to the publicly released gem to confirm stability and get the PR released
* Once confirmed, switch the repository to public by opening a second terraform PR to switch the flag
* At your leisure, perhaps with the next code change, bump it up to 1.0.0 to indicate it's stable and ready for use in production by the general public

.travis.yml

gems/simplekiq/.travis.yml

Austio · 2022-03-25T17:59:05Z

simplekiq.gemspec

+  spec.add_development_dependency "pry"
+
+  spec.add_dependency "sidekiq", "~> 5.2.9"
+  spec.add_dependency "sidekiq-pro", "~> 5.0.0"


❓ Is it possible to release the gem without a dependency on sidekiq pro? Would increase the pool of people that could contribute/use

@Austio Unfortunately it's not, most/all of the features in this gem depend on Sidekiq::Batch which is a sidekiq-pro mechanism.

Gemfile.lock

Austio

Looks good, think we should test for 2.7.5 for ruby and 3.0.3 and remove the Gemfile.lock

Avoids confusion about sidekiq-pro being under rubygems when it's in fact not available there

Artifacts from the git history migration

Remove lockfile, this is a library

jacknoble and others added 18 commits February 4, 2022 15:59

Lowercase 'Kiq'

7a1be45

Copy fix

edc726a

Update to match the new Simplekiq namespace

9c462b7

Allow batch object customization

55ef1c8

Previously, Simplekiq did not provide a way to interact with the underlying batch object.

Add documentation

55c631f

Eliminate direct use of sidekiq batch object

24dfc91

There was concern about exposing the sidekiq batch directly and making a habit of it, so we move it to a private object. Still accessible if you need it through `send` in say a REPL situation, but otherwise not usable.

Fix deprecation warning, system spec

2b997bb

Make child batch if in existing batch

c65655c

Clean up orchestration

38a65ad

Get system specs passing

17de5fb

Add batch test for orchestration job

34834b9

Fix spec, cleanup

ce60445

Expand comment on child batches

bb4d110

Add ensure, move list match orchestration inside parent

f4b285c

Refactor to remove intermediate job

23bb490

Rubocop fixes

96000c6

Avoid 'workflow' to prevent confusion with the workflows functionality

5651ade

Add on_complete support to simplekiq

cdc05f0

jacknoble approved these changes Feb 7, 2022

View reviewed changes

Tiphani and others added 6 commits March 2, 2022 16:37

batching sidekiq options

7128f4b

Refactor PersonalizedContents job into Simplekiq

28bd13e

The Simplekiq Batching Job API now supports everything this job needed. We can have the ProcessAllJob now take advantage of this so the batch can be defined in a single class.

Staged version of simplekiq extraction

cadbfa9

Still needs some polish around the edges, but this is at least functional

Delete the default README

9054fd7

move files from staged location to gem root

6164c32

Additional tweaks prepping for release

f0d1252

jcwilk force-pushed the jcw/maintained_history_release branch from aa20ef2 to f0d1252 Compare March 3, 2022 00:39

Clarify contributors/authors/etc

1a04459

jcwilk force-pushed the jcw/maintained_history_release branch from 101a834 to 1a04459 Compare March 3, 2022 01:02

Add CONTRIBUTING.md for license agreement

b5c55da

jcwilk force-pushed the jcw/maintained_history_release branch from a98f7e7 to b5c55da Compare March 3, 2022 01:10

update the fine print of the README

23a3af2

jcwilk changed the title ~~Jcw/maintained history release~~ Initial release including curated git history from the original repository Mar 3, 2022

Add first attempt at auto-building ci config

acb0fdd

Stolen from https://github.com/doximity/shoulda-matchers-uuid/blob/5da06b2068633516e3776966e39a544f864d795f/.circleci/config.yml with minor adjustments (mainly skipping anything related to mysql)

Austio reviewed Mar 25, 2022

View reviewed changes

.travis.yml Outdated Show resolved Hide resolved

Austio reviewed Mar 25, 2022

View reviewed changes

gems/simplekiq/.travis.yml Outdated Show resolved Hide resolved

Austio reviewed Mar 25, 2022

View reviewed changes

Gemfile.lock Outdated Show resolved Hide resolved

Austio approved these changes Mar 25, 2022

View reviewed changes

jcwilk added 3 commits March 25, 2022 11:18

remove Gemfile.lock

65580d0

Avoids confusion about sidekiq-pro being under rubygems when it's in fact not available there

Remove travis.yml

7672c42

Oops these aren't supposed to be here

d67bc22

Artifacts from the git history migration

jcwilk merged commit 1eedee1 into master Mar 25, 2022

jcwilk deleted the jcw/maintained_history_release branch March 25, 2022 21:48

morriswchris pushed a commit to morriswchris/simplekiq that referenced this pull request Aug 9, 2024

Merge pull request doximity#2 from OpsLevel/ehuus/remove-lockfile

ddb0727

Remove lockfile, this is a library

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Initial release including curated git history from the original repository #2

Initial release including curated git history from the original repository #2

jcwilk commented Feb 5, 2022

jcwilk commented Mar 24, 2022

Austio Mar 25, 2022

jcwilk Mar 25, 2022

Austio left a comment

Initial release including curated git history from the original repository #2

Initial release including curated git history from the original repository #2

Conversation

jcwilk commented Feb 5, 2022

jcwilk commented Mar 24, 2022

Austio Mar 25, 2022

Choose a reason for hiding this comment

jcwilk Mar 25, 2022

Choose a reason for hiding this comment

Austio left a comment

Choose a reason for hiding this comment