Skip to content

Remove rspec-doc-template yard plugin + remove empty lines from HTML doc #245

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 6, 2020

Conversation

benoittgt
Copy link
Member

We do not want Google Analytics because we don't use it
Also rdoc/erb generate a lot of extra empty line in every html. We clean
all the html files before.
@benoittgt benoittgt marked this pull request as ready for review April 5, 2020 17:06
Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 LGTM

@@ -26,7 +26,7 @@ def run_command(command, opts={})
FileUtils.cd(path) do
puts "#{'='*3} #{dir} #{'='*(40 - dir.length)}"
begin
Bundler.clean_system(command)
Bundler.unbundled_system(command)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm theres a reason we were using clean_system but I've forgotten what it is

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my case, I just followed the deprecation warning.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah then I think its a bundler 1 vs 2 issue

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a blocker for this PR?

On another project we added an helper method that check if unbundled_system was defined, if not, fallback to clean_system. But I think we can keep it like this.

I didn't try all the rake commands and I lack history on the subject so feel free to tell me Jon.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No it's our dev tools, we can always revert.

@benoittgt benoittgt changed the title Testing line removal Remove rspec-doc-template yard plugin + remove empty lines from HTML doc Apr 6, 2020
The previous script run commands `ag` commands on rspec-github.io and
not the source/lib/version folder. It means we are doing extra work
everytime we generate documentation.

With this change we reduce the scope of files that can be processed but
also the command is much faster.
@benoittgt
Copy link
Member Author

Sorry, last night I remember that my script to remove lines is not scoped to the rspec gem version you want in source/ folder in rspec.github.io. There is the same behavior for the two other bash commands.

I added a commit that do sed changes only on the gems and version that you asked. This will avoid extra work on all documentation every time we publish.

This was maybe a choice that is wanted. I can revert it. 😊

I will keep the all lines already removed in rspec.gihub.io because it is a necessary cleaning.

The last commit do not change the doc generated (expect doc generation timestamp in footer).

@benoittgt benoittgt requested a review from pirj April 6, 2020 16:39
Copy link
Member

@pirj pirj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good.
I would prefer not to keep the script focused on just one project/version, but it's ok focused as well.

@JonRowe JonRowe merged commit ec82960 into master Apr 6, 2020
@JonRowe JonRowe deleted the testing-line-removal branch April 6, 2020 17:55
@benoittgt
Copy link
Member Author

Thanks Jon :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants