Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Drop legacy yard tasks #1805

Merged
merged 1 commit into from
Apr 14, 2023
Merged

Drop legacy yard tasks #1805

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 0 additions & 122 deletions Rakefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,6 @@ end

task :acceptance => ['test:base', 'test:hypervisor']

task :yard do
Rake::Task['docs:gen'].invoke
end

task :history do
Rake::Task['history:gen'].invoke
end

module HarnessOptions
defaults = {
:tests => ['tests'],
Expand Down Expand Up @@ -189,120 +181,6 @@ namespace :test do
end
end

###########################################################
#
# History Tasks
#
###########################################################
namespace :history do
desc 'Generate HISTORY.md'
task :gen do
Dir.chdir(__dir__) do
output = `bundle exec ruby history.rb .`
puts output
raise "History generation failed" if !output.include?('success')
end
end
end

###########################################################
#
# Documentation Tasks
#
###########################################################
DOCS_DIR = 'yard_docs'
DOCS_DAEMON = "yard server --reload --daemon --docroot #{DOCS_DIR}"
FOREGROUND_SERVER = "bundle exec yard server --reload --verbose lib/beaker --docroot #{DOCS_DIR}"

def running?(cmdline)
ps = `ps -ef`
found = ps.lines.grep(/#{Regexp.quote(cmdline)}/)
raise StandardError, "Found multiple YARD Servers. Don't know what to do." if found.length > 1

yes = found.empty? ? false : true
return yes, found.first
end

def pid_from(output)
output.squeeze(' ').strip.split(' ')[1]
end

desc 'Start the documentation server in the foreground'
task :docs => 'docs:clear' do
Dir.chdir(__dir__) do
sh FOREGROUND_SERVER
end
end

namespace :docs do
desc 'Clear the generated documentation cache'
task :clear do
Dir.chdir(__dir__) do
sh "rm -rf #{DOCS_DIR}"
end
end

desc 'Generate static documentation'
task :gen => 'docs:clear' do
Dir.chdir(__dir__) do
output = `bundle exec yard doc -o #{DOCS_DIR}`
puts output
fail "Errors/Warnings during yard documentation generation" if /\[warn\]|\[error\]/.match?(output)
end
end

desc 'Run the documentation server in the background, alias `bg`'
task :background => 'docs:clear' do
yes, output = running?(DOCS_DAEMON)
if yes
puts "Not starting a new YARD Server..."
puts "Found one running with pid #{pid_from(output)}."
else
Dir.chdir(__dir__) do
sh "bundle exec #{DOCS_DAEMON}"
end
end
end

task(:bg) { Rake::Task['docs:background'].invoke }

desc 'Check the status of the documentation server'
task :status do
yes, output = running?(DOCS_DAEMON)
if yes
pid = pid_from(output)
puts "Found a YARD Server running with pid #{pid}"
else
puts "Could not find a running YARD Server."
end
end

desc "Stop a running YARD Server"
task :stop do
yes, output = running?(DOCS_DAEMON)
if yes
pid = pid_from(output)
puts "Found a YARD Server running with pid #{pid}"
`kill #{pid}`
puts "Stopping..."
yes, _output = running?(DOCS_DAEMON)
if yes
`kill -9 #{pid}`
yes, _output = running?(DOCS_DAEMON)
if yes
puts "Could not Stop Server!"
else
puts "Server stopped."
end
else
puts "Server stopped."
end
else
puts "Could not find a running YARD Server"
end
end
end

begin
require 'rubygems'
require 'github_changelog_generator/task'
Expand Down
3 changes: 0 additions & 3 deletions beaker.gemspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,6 @@ Gem::Specification.new do |s|
s.add_development_dependency 'rake', '~> 13.0'
s.add_development_dependency 'rspec', '~> 3.0'

# Documentation dependencies
s.add_development_dependency 'yard', '~> 0.9.11'

# Run time dependencies
s.add_runtime_dependency 'minitar', '~> 0.6'
s.add_runtime_dependency 'minitest', '~> 5.4'
Expand Down