Add Podfile DSL for `script_phase` #389

dnkoutso · 2017-06-20T02:25:29Z

No description provided.

dnkoutso · 2017-06-20T02:29:05Z

lib/cocoapods-core/podfile/dsl.rb

+      #
+      # @return   [void]
+      #
+      def script_phase(options)


should this be modeled differently? maybe:

def script_phase(name, script, options = nil)

And provide a new class perhaps?

segiddins · 2017-06-20T02:48:35Z

lib/cocoapods-core/podfile/dsl.rb

+      #
+      def script_phase(options)
+        raise Informative, 'Script phases can only be added within target definitions.' if current_target_definition.root?
+        raise Informative, 'Script phases cannot be added to abstract targets.' if current_target_definition.abstract?


hm, I think it might make sense to allow defining script phases for abstract targets, since the build env will be different for the concrete targets that inherit it

I didn't put that much effort into it, I think it could work but for starters it might be OK?

dnkoutso · 2017-06-20T16:02:20Z

lib/cocoapods-core/podfile/target_definition.rb

@@ -573,6 +581,36 @@ def store_podspec(options = nil)
        end
      end

+      #--------------------------------------#
+
+      SCRIPT_PHASE_REQUIRED_KEYS = [:name, :script].freeze


minor update to use constants for these to make it easier to read and modify in the future.

dnkoutso · 2017-06-20T23:57:45Z

lib/cocoapods-core/podfile/dsl.rb

+      # @option   options [Boolean] :show_env_vars_in_log
+      #           whether this script phase should output the environment variables during execution.
+      #
+      # @option   options [Symbol] :execution_order


@segiddins @dantoml I am curious on what do you think this API should be...

Should we even handle this case for starters?

If yes, how have you imagined it to work in terms of before or after compile sources, what about other phases like linking or headers? Could the API become execute_before => 'Compile Sources' instead?

Another option could be to just let users specify and index index => 1 and we just insert that where the user asked...no questions and no special logic.

The other way is...not to handle this at all and since this is actually adding a script phase to the users project, let the user drag the script phase and manage it manually instead.

...and another thing is that consumers can use post_install hooks to re-arrange their script phases....

talked with some of my team members...seems like manual drag/post_install hook will be a good way to go. Will remove it from here.

Hmmm, I tried this today:

Added some script_phases

run pod install

move phases to correct position

run pod install again

The custom positions are lost. CocoaPods should either keep the positions, or provide a way of specifying the positions, I think?

You mean the custom shell script positions are lost? If confirmed, can you please provide a sample project and file an issue with the project attached?

Jep, that's what I mean. I'll try to create a small sample project.

@djbe ah, I think I see what you mean. If you mean you manually readjust a script phase after you've added but then it still gets reordered after another pod install then you will need a post_install hook to arrange it. This is how it landed on master instead.

We can definitely do better but I think I now understand what you mean. Please file this in https://github.com/CocoaPods/CocoaPods so we do not comment on this merged PR further and I can mark it as an enhancement.

endocrimes · 2017-07-02T21:44:48Z

This is looking good, definitely a 1.4 feature i think tho, to avoid blocking 1.3 on bugs

dnkoutso · 2017-07-10T01:12:23Z

yeah lets wait for 1.4.0 for this.

dnkoutso · 2017-08-02T19:50:32Z

If you care this is green and still feels good to merge. The bigger splash is about allowing podspecs to include script phases which I am hoping i can introduce in a follow up PR.

In the meantime this allows devs to include script phases within their podfiles for app targets.

segiddins · 2017-08-02T20:15:51Z

lib/cocoapods-core/podfile/target_definition.rb

+      def store_script_phase(options)
+        option_keys = options.keys
+        unless option_keys.all? { |key| ALL_SCRIPT_PHASE_KEYS.include?(key) }
+          raise StandardError, 'Unrecognized options for the shell script ' \


might be nice to say which options are unrecognized, and print out the known ones?

sure will update

dnkoutso · 2017-08-22T15:23:33Z

rebased

dnkoutso · 2017-08-22T16:43:30Z

Any objections of landing this feature? It's useful but not that useful as for podspecs having the ability to declare script phases.

I think we can land this and then just have it exist.

dnkoutso · 2017-08-25T22:14:38Z

rebased. Will merge on ✅

dnkoutso · 2017-08-25T22:17:28Z

@dantoml please do let me know if you are against this. I'd be happy to revert. Its a minor useful feature that I built in 30 minutes. Its corresponding CocoaPods PR also prepares the ground for managing script phases declared within podspecs.

I am planning on a follow up for podspec DSL.

CocoaPods PR: CocoaPods/CocoaPods#6820

dnkoutso force-pushed the script_phase_dsl branch from 3feb950 to 40b7653 Compare June 20, 2017 02:26

dnkoutso commented Jun 20, 2017

View reviewed changes

segiddins reviewed Jun 20, 2017

View reviewed changes

dnkoutso force-pushed the script_phase_dsl branch 4 times, most recently from e80f96d to ca601f3 Compare June 20, 2017 16:01

dnkoutso commented Jun 20, 2017

View reviewed changes

dnkoutso force-pushed the script_phase_dsl branch 6 times, most recently from 14de1b5 to 5ca9e9c Compare June 20, 2017 22:34

dnkoutso mentioned this pull request Jun 20, 2017

Add custom shell script integration from Podfile CocoaPods/CocoaPods#6820

Merged

dnkoutso force-pushed the script_phase_dsl branch from 5ca9e9c to a91b641 Compare June 20, 2017 23:27

dnkoutso commented Jun 20, 2017

View reviewed changes

dnkoutso mentioned this pull request Jun 21, 2017

Additional environmental variables for prepare_command CocoaPods/CocoaPods#2115

Closed

dnkoutso force-pushed the script_phase_dsl branch 2 times, most recently from 4ca07e2 to 4b380ef Compare June 23, 2017 17:56

dnkoutso added this to the 1.4 milestone Jul 10, 2017

dnkoutso force-pushed the script_phase_dsl branch 2 times, most recently from a20fcce to 165c45a Compare July 14, 2017 21:59

below mentioned this pull request Jul 19, 2017

Replace CryptoSwift dependency with CommonCrypto below/JSONWebToken.swift#1

Open

dnkoutso force-pushed the script_phase_dsl branch 3 times, most recently from 50e632b to 6f988d3 Compare August 2, 2017 19:46

segiddins reviewed Aug 2, 2017

View reviewed changes

dnkoutso force-pushed the script_phase_dsl branch 2 times, most recently from 0683749 to c2f444e Compare August 2, 2017 20:53

dnkoutso force-pushed the script_phase_dsl branch from c2f444e to 2ba1e9e Compare August 22, 2017 15:23

Add Podfile DSL for script_phase

67ef132

dnkoutso force-pushed the script_phase_dsl branch from 2ba1e9e to 67ef132 Compare August 25, 2017 22:13

dnkoutso merged commit bdec7d4 into CocoaPods:master Aug 25, 2017

djbe mentioned this pull request Sep 25, 2017

script_phases don't preserve order after pod install CocoaPods/CocoaPods#7065

Closed

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Podfile DSL for `script_phase` #389

Add Podfile DSL for `script_phase` #389

dnkoutso commented Jun 20, 2017 •

edited

Loading

dnkoutso Jun 20, 2017 •

edited

Loading

segiddins Jun 20, 2017

dnkoutso Jun 20, 2017

segiddins Jun 20, 2017

dnkoutso Jun 20, 2017

dnkoutso Jun 20, 2017 •

edited

Loading

dnkoutso Jun 21, 2017

dnkoutso Jun 21, 2017

dnkoutso Jun 21, 2017

djbe Sep 25, 2017

dnkoutso Sep 25, 2017

djbe Sep 25, 2017

dnkoutso Sep 25, 2017

endocrimes commented Jul 2, 2017

dnkoutso commented Jul 10, 2017

dnkoutso commented Aug 2, 2017

segiddins Aug 2, 2017

dnkoutso Aug 2, 2017

dnkoutso Aug 2, 2017

dnkoutso commented Aug 22, 2017

dnkoutso commented Aug 22, 2017

dnkoutso commented Aug 25, 2017

dnkoutso commented Aug 25, 2017 •

edited

Loading

Add Podfile DSL for script_phase #389

Add Podfile DSL for script_phase #389

Conversation

dnkoutso commented Jun 20, 2017 • edited Loading

dnkoutso Jun 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnkoutso Jun 20, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

endocrimes commented Jul 2, 2017

dnkoutso commented Jul 10, 2017

dnkoutso commented Aug 2, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dnkoutso commented Aug 22, 2017

dnkoutso commented Aug 22, 2017

dnkoutso commented Aug 25, 2017

dnkoutso commented Aug 25, 2017 • edited Loading

Add Podfile DSL for `script_phase` #389

Add Podfile DSL for `script_phase` #389

dnkoutso commented Jun 20, 2017 •

edited

Loading

dnkoutso Jun 20, 2017 •

edited

Loading

dnkoutso Jun 20, 2017 •

edited

Loading

dnkoutso commented Aug 25, 2017 •

edited

Loading