Skip to content

Update README.md#5

Open
Guido07111975 wants to merge 2 commits intoClassicPress:mainfrom
Guido07111975:Workflows-2
Open

Update README.md#5
Guido07111975 wants to merge 2 commits intoClassicPress:mainfrom
Guido07111975:Workflows-2

Conversation

@Guido07111975
Copy link
Contributor

Minor change: the last part of the sentence makes no sense.

@xxsimoxx
Copy link
Member

For me that sentence makes sense but is unclear. The message is that a proper zip file, regardless of the name of the ZIP file, expands to a folder that is named as the plugin/theme slug.

@Guido07111975
Copy link
Contributor Author

Do you mean in this example "doit-" is always added automatically? doit-v9.0.5.zip

Or do you mean the folder name "doit" in the path?

@xxsimoxx
Copy link
Member

xxsimoxx commented Mar 17, 2026

I mean that you can have even a ZIP named random.zip, but when expanded it must create a folder named as the plugin slug, and not expand to files not inside a folder.

That said, the action creates a "properly crafted zip file" means what I said before.

@Guido07111975
Copy link
Contributor Author

Totally forgot, we talked about this before!

That info is for people that host their software outside GH, but need a properly crafted zip file for the CP Directory, right?

If I'm right, I will undo my previous commit.
And to make things more clear, this sentence should be a new paragraph:
You can also add a ZIP file..

Agree?

@xxsimoxx
Copy link
Member

Even "You can also add a ZIP file (that contains your plugin or theme) from elsewhere, as long as it has the same name format as explained below." is not related to the workflow. The workflow is intended to create a proper ZIP for you, maybe that infos belongs to directory instructions.

@Guido07111975
Copy link
Contributor Author

Guido07111975 commented Mar 17, 2026

Good point, the Directory Requirements docs already contain some release info (See Releases heading). It does not contain the info about the included folder name.

We can decide to remove the info from this repo and include it in the docs instead?

@xxsimoxx
Copy link
Member

I think that it's the best solution.

As discussed with Simone
@Guido07111975
Copy link
Contributor Author

Do you agree with my latest commit? I will update the docs later.

Copy link
Member

@xxsimoxx xxsimoxx 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!

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.

2 participants