Add GHA CI workflow by archanaserver · Pull Request #62 · theforeman/foreman_plugin_template

archanaserver · 2024-03-19T21:01:30Z

No description provided.

archanaserver · 2024-03-19T21:14:52Z

I had this doubt earlier, how can we pass this error:

The gemspec at
/home/runner/work/foreman_plugin_template/foreman_plugin_template/foreman_plugin_template.gemspec
is not valid. Please fix this gemspec.
The validation error was '"FIXME" or "TODO" is not an author'

and without resolving this, how can we check if rubocop is passing or not here #60 #61? What am I missing here @ekohl?

.github/workflows/ci_test.yml

ekohl

and without resolving this, how can we check if rubocop is passing or not here #60 #61? What am I missing here @ekohl?

I would not run the workflow at all and rename it. So I've left a comment on the template file to rename. Then you modify rename.rb to rename it when a user actually creates a plugin, similar to this:

foreman_plugin_template/rename.rb

Line 65 in ddd8127

FileUtils.mv('README.plugin.md', 'README.md')

.github/workflows/ci_test.yml

ekohl

It doesn't appear to replace the content in the file. Probably because line 35 in rename.rb also matches .github.

ekohl · 2024-04-05T15:19:23Z

rename.rb

 FileUtils.rm_rf(old_dirs)

 FileUtils.mv('README.plugin.md', 'README.md')
+FileUtils.mv('ci.yml.tpl', 'ci.yml')


This fails for me:

$ ./rename.rb foreman_best_plugin /usr/share/ruby/fileutils.rb:1181:in `rename': No such file or directory @ rb_file_s_rename - (ci.yml.tpl, ci.yml) (Errno::ENOENT) from /usr/share/ruby/fileutils.rb:1181:in `block in mv' from /usr/share/ruby/fileutils.rb:2481:in `block in fu_each_src_dest' from /usr/share/ruby/fileutils.rb:2497:in `fu_each_src_dest0' from /usr/share/ruby/fileutils.rb:2479:in `fu_each_src_dest' from /usr/share/ruby/fileutils.rb:1172:in `mv' from ./rename.rb:66:in `<main>'

You should use Find.prune if the directory is .git. https://docs.ruby-lang.org/en/master/Find.html documents it.

Suggested change

FileUtils.mv('ci.yml.tpl', 'ci.yml')

FileUtils.mv('.github/workflows/ci.yml.tpl', '.github/workflows/ci.yml')

ekohl

And please also drop the Jenkins integration while you're at it. At least this:

foreman_plugin_template/lib/tasks/foreman_plugin_template_tasks.rake

Lines 45 to 48 in d9ca190

    
           load 'tasks/jenkins.rake' 
        
           if Rake::Task.task_defined?(:'jenkins:unit') 
        
             Rake::Task['jenkins:unit'].enhance ['test:foreman_plugin_template', 'foreman_plugin_template:rubocop'] 
        
           end

Edit: #59 has pretty much what's needed.

rename.rb

ekohl · 2024-04-09T12:42:24Z

#62 (comment) is still relevant. Please follow the README and pretend to a user of it. You can even consider writing some CI for the repo itself where it calls rename.rb and you verify it replaced in certain known locations.

ekohl · 2024-05-16T08:10:32Z

rename.rb

 FileUtils.rm_rf(old_dirs)

 FileUtils.mv('README.plugin.md', 'README.md')
+FileUtils.mv('ci.yml.tpl', 'ci.yml')


Suggested change

FileUtils.mv('ci.yml.tpl', 'ci.yml')

FileUtils.mv('.github/workflows/ci.yml.tpl', '.github/workflows/ci.yml')

ekohl · 2024-07-31T15:26:12Z

.github/workflows/ci.yml

I think it's most important in this repository that you can use rename.rb, so I think we should also see that step in CI.

ekohl · 2024-08-02T13:07:52Z

.github/workflows/test_rename.yml

I'd have expected this in the regular CI workflow. If not, rename.rb must remove it.

ekohl · 2024-08-02T13:08:23Z

.github/workflows/test_rename.yml

+
+    - name: Run rename.rb
+      run: |
+        chmod +x rename.rb


rename.rb is already executable

Suggested change

chmod +x rename.rb

ekohl · 2024-08-02T13:08:37Z

.github/workflows/test_rename.yml

+
+    steps:
+    - name: Checkout Repository
+      uses: actions/checkout@v2


v2 is very old. I think v4 is the latest

Suggested change

uses: actions/checkout@v2

uses: actions/checkout@v4

ekohl · 2024-08-02T13:10:41Z

.github/workflows/ci.yml.tpl

Currently I don't see any difference compared to ci.yml so now there would be no value in implementing it as a template. Depending on how you handle the test_rename.yml comments it may or may not make sense to keep it.

ekohl · 2024-08-02T13:12:14Z

.github/workflows/test_rename.yml

+        if [ ! -f "README.md" ]; then
+          echo "README.md not found!"
+          exit 1
+        fi
+
+        if [ ! -f ".github/workflows/ci.yml" ]; then
+          echo ".github/workflows/ci.yml not found!"
+          exit 1
+        fi


Both of these are also present without running rename so they're a poor test. You should really test for the content.

archanaserver · 2024-08-09T07:23:32Z

@ekohl seems like i don't understand what we talked earlier about writing CI for rename.rb script. can you guide me more?

archanaserver · 2024-10-18T13:22:02Z

rename.rb

+  if File.basename(path) == '.git'
+    Find.prune
+  elsif File.file?(path)
+    system(%(sed -i 's/foreman_plugin_template/#{snake}/g; s/ForemanPluginTemplate/#{camel}/g; s/foremanPluginTemplate/#{camel_lower}/g' #{path}))


This line should now fix this issue: #63

I'd like it if it was at least a separate commit for visibility.

archanaserver · 2024-10-18T13:23:58Z

The script is working fine now, @ekohl do you mind looking into it?

ekohl · 2024-12-05T11:09:08Z

.github/workflows/ci.yml

+              exit 1
+            fi
+
+            if ! grep -q "$PLUGIN_NAME" "$file"; then


I would also assert that foreman_plugin_template, ForemanPluginTemplate and foremanPluginTemplate do not show up anymore.

ekohl · 2024-12-05T11:10:59Z

.github/workflows/ci.yml

+
+  rename_test:
+    name: Rename Script Test
+    needs: [rubocop, test]


I think this should be independent. Often a reason to make it depend on others is to save on CI costs, but the rename is very cheap. In fact, I would probably turn it around: make the tests depend on renaming.

ekohl · 2024-12-05T11:12:02Z

rename.rb

  if path =~ /foreman_plugin_template/i
    new = path.gsub('foreman_plugin_template', snake)
    # Recursively copy the directory and store the original for deletion
-    # Check for $ because we don't need to copy template/hosts for example


Why do you drop this comment?

ekohl · 2024-12-05T11:18:10Z

.github/workflows/ci.yml

+
+    env:
+      PLUGIN_NAME: foreman_plugin_template
+      FILES_TO_CHECK: "README.md,.github/workflows/ci.yml"


I would also check if a file rename worked. For example, you could check that find -name '*foreman_plugin_template*' doesn't show any files and verify the new files do exist.

ekohl · 2024-12-05T11:18:34Z

.github/workflows/ci.yml

+    runs-on: ubuntu-latest
+
+    env:
+      PLUGIN_NAME: foreman_plugin_template


This is exactly the same name as the template, so a rename is not going to do anything.

archanaserver force-pushed the gha branch 2 times, most recently from 79f455a to 975c327 Compare March 19, 2024 21:05

archanaserver commented Mar 19, 2024

View reviewed changes

.github/workflows/ci_test.yml Show resolved Hide resolved

ekohl requested changes Mar 20, 2024

View reviewed changes

.github/workflows/ci_test.yml Show resolved Hide resolved

pr-processor bot added the waiting on contributor label Mar 20, 2024

ekohl reviewed Mar 20, 2024

View reviewed changes

.github/workflows/ci_test.yml Outdated Show resolved Hide resolved

archanaserver force-pushed the gha branch from 2247918 to e9ce7f3 Compare April 3, 2024 12:20

archanaserver marked this pull request as ready for review April 3, 2024 12:20

ekohl requested changes Apr 5, 2024

View reviewed changes

ekohl mentioned this pull request Apr 5, 2024

use theforeman-rubocop gem #60

Merged

archanaserver force-pushed the gha branch from e9ce7f3 to 58bc893 Compare April 8, 2024 10:04

ekohl requested changes Apr 8, 2024

View reviewed changes

rename.rb Outdated Show resolved Hide resolved

archanaserver force-pushed the gha branch from 58bc893 to a3bf6aa Compare April 8, 2024 12:01

archanaserver force-pushed the gha branch from a3bf6aa to c517f61 Compare May 23, 2024 09:45

ekohl requested changes Jul 31, 2024

View reviewed changes

archanaserver force-pushed the gha branch from c517f61 to 7566c64 Compare August 2, 2024 08:47

ekohl requested changes Aug 2, 2024

View reviewed changes

archanaserver force-pushed the gha branch from 1bab8fb to 6d7e298 Compare October 18, 2024 12:26

Add GHA CI workflow

58f614d

archanaserver force-pushed the gha branch from 6d7e298 to 58f614d Compare October 18, 2024 13:20

archanaserver commented Oct 18, 2024

View reviewed changes

archanaserver requested a review from ekohl October 18, 2024 13:24

ekohl reviewed Dec 5, 2024

View reviewed changes

	FileUtils.mv('ci.yml.tpl', 'ci.yml')
	FileUtils.mv('.github/workflows/ci.yml.tpl', '.github/workflows/ci.yml')

	load 'tasks/jenkins.rake'
	if Rake::Task.task_defined?(:'jenkins:unit')
	Rake::Task['jenkins:unit'].enhance ['test:foreman_plugin_template', 'foreman_plugin_template:rubocop']
	end

Conversation

archanaserver commented Mar 19, 2024

Uh oh!

archanaserver commented Mar 19, 2024

Uh oh!

Uh oh!

ekohl left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ekohl left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ekohl left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ekohl commented Apr 9, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

archanaserver commented Aug 9, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

archanaserver commented Oct 18, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ekohl left a comment •

edited

Loading